python / python/cpython

Cmd.onecmd documentation is misleading

Ouverte
#76,464 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

3.7 (EOL) stdlib
Langage dominant
Python
Étoiles
77.2k
Forks
36k
Métriques de merge des PR
Métriques de PR en attente

Description

BPO 32283

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2017-12-12.00:20:54.862>
labels = ['3.7', 'library']
title = 'Cmd.onecmd documentation is misleading'
updated_at = <Date 2017-12-12.00:20:54.862>
user = 'https://bugs.python.org/lyda'

bugs.python.org fields:

activity = <Date 2017-12-12.00:20:54.862>
actor = 'lyda'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2017-12-12.00:20:54.862>
creator = 'lyda'
dependencies = []
files = []
hgrepos = []
issue_num = 32283
keywords = []
message_count = 1.0
messages = ['308082']
nosy_count = 1.0
nosy_names = ['lyda']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue32283'
versions = ['Python 3.6', 'Python 3.7']

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

Commencez par localiser la documentation de la bibliothèque pour Cmd.onecmd et comparez sa formulation avec le comportement documenté. L’issue n’identifie aucun fichier et n’explique pas quel texte est trompeur ; déterminez donc la clarification nécessaire avant de modifier quoi que ce soit ; le travail est terminé lorsque la documentation décrit correctement Cmd.onecmd et que les vérifications de la documentation passent.

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é
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

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