[CI]: Consider/Discuss Tools for Verifying Fenced Code in Markdown Documents
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- markdown, python
- Ambito
- ci-cd, documentation, testing
Direzione di ricerca
Inizia esaminando introduction.md, about.md e instruction.md, quindi confronta doctest, mkcodes e pmdoctest con i rispettivi fenced Python examples. Definisci quale strategia gestisce i fence documentati e come l’integrazione CI li verificherebbe; il lavoro è completato quando sono stati concordati uno strumento e un percorso di valutazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
This came up in discussing PR #2838, so opening an issue here for longer discussion/evaluation.
We currently "hand validate" example python code used in introduction.md, about.md, and instruction.md and similar documents. This leads to errors where certain code will not work in the REPL, or syntax or other errors get made and published. As we scale up exercises, this doesn't feel like a sustainable solution, hence this issue to propose, evaluate, and track possible tools and strategies for verifying code , and (possibly) adding that verification to the track CI.
Below are three applicable libraries, but I'd warmly welcome more. Of the three below, pmdoctest feels like the nicest solution, and I've run the comparisons concept exercise through it with reasonable results. But I'd like to see if there are other strategies/libraries out there.
doctest - this is the old-school original, but doesn't really work well in markdown fences.
mkcodes - have not tried this yet.
pmdoctest - reasonably good, but requires some weird quirks with code fence language names and or excess >>> in code fences to make parsing work.
- Lingua principale
- Python
- Stelle
- 2.5k
- Fork
- 1.5k
- Merge medio
- 2g 17h
- PR unite (30g)
- 2
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di exercism/python
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 75/100
-
Current status of approachesAperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 35/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
-
[General Docs] Audit/Cleanup of Track General/Shared DocsForse già presa @Yrahcaz7 l’ha presa 6 giorni fa. Aperta
-
[Decimals]: New Concept and Concept ExerciseForse di nuovo libera @BethanyG l’ha presa 516 giorni fa e non c’è nessuna pull request aperta. Aperta
Tutte le issue di exercism/python
Issue simili
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
snap-stanford/Biomni#380 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
microsoft/playwright-python#3361 ·
I maintainer di solito rispondono entro 1 giorno
-
documentation priority: low size: S status: needs triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
cubrid-lab/sqlalchemy-cubrid#1397 ·
I maintainer di solito rispondono entro 1 giorno
-
documentation priority: low size: S status: needs triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
cubrid-lab/pycubrid#1307 ·
I maintainer di solito rispondono entro 1 giorno
-
[Bug]: Installer hides SSL certificate errors as bare URLError, and the suggested fix can't workApertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 80/100
ShaftHQ/chaosengine-harness#143 ·
I maintainer di solito rispondono entro 1 giorno