python / python/cpython

Misleading documentation for NotImplemented

Ouverte
#83,292 6 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

3.7 (EOL) 3.8 (EOL) 3.9 (EOL) docs type-feature
Langage dominant
Python
Étoiles
77.2k
Forks
36k
Métriques de merge des PR
Métriques de PR en attente

Description

BPO 39111
Nosy @stevendaprano, @Murali

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 2019-12-20.16:42:56.150>
labels = ['3.8', 'type-feature', '3.7', '3.9', 'docs']
title = 'Misleading documentation for NotImplemented'
updated_at = <Date 2019-12-28.07:11:38.640>
user = 'https://github.com/Murali'

bugs.python.org fields:

activity = <Date 2019-12-28.07:11:38.640>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-12-20.16:42:56.150>
creator = 'murali'
dependencies = []
files = []
hgrepos = []
issue_num = 39111
keywords = []
message_count = 5.0
messages = ['358719', '358722', '358723', '358726', '358752']
nosy_count = 3.0
nosy_names = ['steven.daprano', 'docs@python', 'murali']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue39111'
versions = ['Python 3.7', 'Python 3.8', 'Python 3.9']

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 examiner la documentation de NotImplemented et l’issue BPO 39111 liée afin d’identifier la formulation qui prête à confusion. Le payload de l’issue ne mentionne aucun fichier, aucun test ni aucune correction précise ; confirmez donc la modification prévue de la documentation avant de modifier quoi que ce soit et vérifiez que le texte révisé décrit correctement NotImplemented.

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
35/100

Recevez les nouvelles issues par e-mail

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