python / python/cpython

unittest assert helper methods have incorrect signature in docs

Offen
#79,857 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

docs
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
36k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

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']

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die unittest-Dokumentation für die assert-Hilfsmethoden zu finden, und vergleiche die dokumentierten Signaturen mit ihren tatsächlichen APIs. Aktualisiere die fehlerhafte Dokumentation und bestätige, dass die Signaturen in der gerenderten Dokumentation korrekt sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.