pyjanitor-devs
[DOC] In-line examples in functions.py docstrings should be made into notebooks
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
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!
Could write a script that fills in a skeleton notebook with the docstring from each function. We'd then go in and convert them into actually-working code. It might make doing this not overkill at all.
