pyjanitor-devs/pyjanitor
Auf GitHub ansehen[DOC] In-line examples in functions.py docstrings should be made into notebooks
Open
#329 geöffnet am 11. Mai 2019
available for hackingdocfixgood intermediate issuehelp wanted
Repository-Metriken
- Stars
- (1.217 Stars)
- PR-Merge-Metriken
- (Durchschn. Merge 2T 12h) (4 gemergte PRs in 30 T)
Beschreibung
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.