pyjanitor-devs/pyjanitor

[DOC] In-line examples in functions.py docstrings should be made into notebooks

Open

#329 ouverte le 11 mai 2019

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Python (164 forks)batch import
available for hackingdocfixgood intermediate issuehelp wanted

Métriques du dépôt

Stars
 (1 217 stars)
Métriques de merge PR
 (Merge moyen 2j 12h) (4 PRs mergées en 30 j)

Description

Brief Description of Fix

Currently, the docs, there are in-line examples that make the docstrings quite long. These are nice, but make functions.py difficult to navigate, in my opinion (lots of scrolling).

I would like to propose moving those in-line examples into notebooks that go in the examples/notebooks directory.

A thing that could be done, but might be overkill, is to make one notebook per function. The upside is that doing so would make the example usage extremely discoverable!

A more reasonable suggestion might be to use them as part of a data cleaning narrative, with end-users using the docs search functionality to discover those examples.

Relevant Context

Guide contributeur

Direction de recherche
Identifiez les fonctions dans functions.py avec des exemples en ligne, créez un notebook pour chaque fonction dans examples/notebooks et mettez à jour le docstring pour faire référence au notebook.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85