pyjanitor-devs/pyjanitor

[DOC] API Policy

Open

#615 geöffnet am 21. Dez. 2019

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (164 Forks)batch import
being worked ondocfixgood first issue

Repository-Metriken

Stars
 (1.217 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 2T 12h) (4 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Lesen Sie das verknüpfte Issue #612 und fügen Sie die zitierte API Richtlinie zur Dokumentation hinzu.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90