AnswerDotAI / AnswerDotAI/nbdev

Render docs for methods by default

Aperta
#293 3 commenti 2 reazioni 0 assegnatari Vedi su GitHub
enhancement
Lingua principale
Jupyter Notebook
Stelle
5.3k
Fork
513
Merge medio
2g 30m
PR unite (30g)
8

Descrizione

We should render docs for methods by default rather than requiring showdoc(...) on each method. Of course its better if people use showdoc(method) as that promotes better docs, but perhaps for people starting out it can help with initial setup?

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Non vengono indicati file, test o punti di ingresso. Inizia individuando l’implementazione e i test di showdoc(method), quindi confronta il rendering predefinito con showdoc(...). L’attività è completata quando la documentazione del metodo viene sottoposta a rendering senza richiedere showdoc(...), mantenendo al contempo il supporto per l’uso esplicito esistente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
jupyter-notebook, python
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
30/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.