pyjanitor-devs/pyjanitor

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

Open

#329 opened on May 11, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (164 forks)batch import
available for hackingdocfixgood intermediate issuehelp wanted

Repository metrics

Stars
 (1,217 stars)
PR merge metrics
 (Avg merge 2d 12h) (4 merged PRs in 30d)

Description

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

Contributor guide

Research direction
Identify functions in functions.py with inline examples, create a notebook for each function in examples/notebooks, and update the docstring to reference the notebook.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85