pyjanitor-devs/pyjanitor

[DOC] API Policy

Open

#615 aperta il 21 dic 2019

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (164 fork)batch import
being worked ondocfixgood first issue

Metriche repository

Star
 (1217 star)
Metriche merge PR
 (Merge medio 2g 12h) (4 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Leggi l'issue collegata #612 e aggiungi la politica API citata alla documentazione.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90