pyjanitor-devs/pyjanitor

[DOC] In-line examples in functions.py docstrings should be made into notebooks

Open

#329 aperta il 11 mag 2019

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Python (164 fork)batch import
available for hackingdocfixgood intermediate issuehelp wanted

Metriche repository

Star
 (1217 star)
Metriche merge PR
 (Merge medio 2g 12h) (4 PR mergiate in 30 g)

Descrizione

Brief Description of Fix

Currently, the docs, there are in-line examples that make the docstrings quite long. These are nice, but make functions.py difficult to navigate, in my opinion (lots of scrolling).

I would like to propose moving those in-line examples into notebooks that go in the examples/notebooks directory.

A thing that could be done, but might be overkill, is to make one notebook per function. The upside is that doing so would make the example usage extremely discoverable!

A more reasonable suggestion might be to use them as part of a data cleaning narrative, with end-users using the docs search functionality to discover those examples.

Relevant Context

Guida contributor

Direzione di ricerca
Identifica le funzioni in functions.py con esempi inline, crea un notebook per ogni funzione in examples/notebooks e aggiorna la docstring per fare riferimento al notebook.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
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
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85