pyjanitor-devs/pyjanitor

[DOC] Improve the examples in janitor.functions.py

Open

#187 opened on May 6, 2019

View on GitHub
 (11 comments) (0 reactions) (1 assignee)Python (1,217 stars) (164 forks)batch import
being worked ondocfixgood first issue

Description

Some docs in the functions in the janitor.functions.py file present runnable code examples, others don't. It could be made consistent through all functions (unless trivial)

Contributor guide

Tech stack
pythonpandas
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonpandasWriting docstrings
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Examine the file janitor/functions.py in the repository. Look for functions with missing or incomplete code examples in their docstrings. Ensure consistency by adding runnable examples that demonstrate basic usage. Review the comments in issue #187 for guidance on which functions to prioritize.