pyjanitor-devs/pyjanitor

[DOC] API Policy

Open

#615 opened on Dec 21, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)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

I would like to put the following API policy in place in the docs:

pyjanitor only extends or aliases the pandas API (and other dataframe APIs), but will never fix or replace them. Undesirable pandas behaviour should be reported upstream in the pandas repository. If at some point the pandas devs decide to take something from pyjanitor and internalize it as part of the official pandas API, then we will deprecate it from pyjanitor, while acknowledge the original contributors' contribution as part of the official deprecation record.

Taken from here in issue #612.

Contributor guide

Research direction
Read the linked issue #612 and add the quoted API policy to the documentation.
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.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90