libgit2 / libgit2/pygit2

Make docstrings to be nice with pydoc

Ouverte
#393 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

documentation
Langage dominant
Python
Étoiles
1.7k
Forks
408
Merge moyen
2 j 57 min
PR mergées (30 j)
7

Description

In some doc-strings we use formatting rules specific to Sphinx, but which make the interactive help (pydoc) to look bad.

This issue is about:

  • defining how we should write some recurrent stuff, like documenting input parameters and return values.
  • rewrite the doc-strings so they look fine on pydoc, even if that means losing some features with Sphinx, like cross references.

Note. If we had the resources, we would do like Python does, and document things twice: once in the doc-strings and a feature rich version in the rst files. But in any case the doc-strings must be usable with pydoc, so lets start with that.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Aucun fichier, test ou point d’entrée n’est nommé. Commencez par inventorier les docstrings du projet et comparer leur sortie rendue dans pydoc aux conventions de Sphinx ; le travail est considéré comme terminé lorsque des règles de formatage ont été convenues pour les paramètres et valeurs de retour récurrents, et que les docstrings ont été réécrits de manière à rester utilisables dans pydoc.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.