p0deje/yard-doctest

Support examples in README.md ?

Aperta

#16 aperta il 6 ott 2020

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)Gherkin (17 fork)github user discovery
enhancementhelp wanted

Metriche repository

Star
 (117 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

If the gem already supports testing examples in README.md, how do we set that up?

If not, since YARD does already process README.md, would it be at all possible to support this? Happy to implement it myself if guidance provided!

Guida contributor

Direzione di ricerca
Indaga come YARD elabora README.md e come yard doctest estrae attualmente esempi dal codice sorgente. Possibilmente estendere il parser per gestire blocchi di codice Markdown nei file README.
Tech stack
ruby
Dominio
documentationtesting
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
RubyYARD
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60