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 (164 forks)batch import
being worked ondocfixgood first issue

Repository metrics

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

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

Research direction
Identify functions in janitor.functions.py missing runnable examples and add them following existing patterns.
Tech stack
python
Domain
documentationdata
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.
80