python / python/cpython

Doc README omits some documentation make targets

Ouverte
#151,833 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

docs
Langage dominant
Python
Étoiles
77.2k
Forks
35.9k
Métriques de merge des PR
Métriques de PR en attente

Description

Doc/README.rst lists the available documentation make targets, but it does not mention texinfo, doctest, or gettext.

These targets are defined in Doc/Makefile, so the README target list can be updated to be more complete for contributors reading the documentation build instructions.

Linked PRs
  • gh-151832

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

Comparez la liste des cibles de Doc/README.rst avec les cibles définies dans Doc/Makefile, en commençant par ces fichiers. Mettez à jour le README pour mentionner texinfo, doctest et gettext, puis vérifiez que la liste documentée correspond aux cibles disponibles.

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é
1/5
Temps estimé
Moins d'une heure
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

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