pyjanitor-devs/pyjanitor

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

Open

#329 创建于 2019年5月11日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)Python (164 fork)batch import
available for hackingdocfixgood intermediate issuehelp wanted

仓库指标

Star
 (1,217 star)
PR 合并指标
 (平均合并 2天 12小时) (30 天内合并 4 个 PR)

描述

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

贡献者指南