python / python/cpython

unittest assert helper methods have incorrect signature in docs

Ouverte
#79,857 3 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
36k
Métriques de merge des PR
Métriques de PR en attente

Description

BPO 35676
Nosy @rbtcollins, @ezio-melotti, @voidspace, @tirkarthi

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-01-07.04:17:47.372>
labels = ['3.11', '3.9', '3.10', 'docs']
title = 'unittest assert helper methods have incorrect signature in docs'
updated_at = <Date 2021-04-25.16:15:40.381>
user = None

bugs.python.org fields:

activity = <Date 2021-04-25.16:15:40.381>
actor = 'iritkatriel'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-01-07.04:17:47.372>
creator = '\xd7\x90\xd7\x95\xd7\xa8\xd7\x99'
dependencies = []
files = []
hgrepos = []
issue_num = 35676
keywords = []
message_count = 3.0
messages = ['333137', '333139', '333163']
nosy_count = 6.0
nosy_names = ['rbcollins', 'ezio.melotti', 'michael.foord', 'docs@python', 'xtreak', '\xd7\x90\xd7\x95\xd7\xa8\xd7\x99']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue35676'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']

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 trouver la documentation de unittest relative aux méthodes d’aide assert et comparez les signatures documentées avec leurs API réelles. Mettez à jour la documentation incorrecte et vérifiez que les signatures sont exactes dans la documentation générée.

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é
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.