python / python/cpython

poor documentation for .startswith, .endswith

Offen
#81,671 10 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 37490
Nosy @stevendaprano, @aldwinaldwin

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-07-03.05:01:35.684>
labels = ['docs']
title = 'poor documentation for .startswith, .endswith'
updated_at = <Date 2020-09-19.18:03:39.370>
user = 'https://bugs.python.org/vpython'

bugs.python.org fields:

activity = <Date 2020-09-19.18:03:39.370>
actor = 'iritkatriel'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-07-03.05:01:35.684>
creator = 'v+python'
dependencies = []
files = []
hgrepos = []
issue_num = 37490
keywords = []
message_count = 9.0
messages = ['347179', '347180', '347185', '347187', '347188', '347189', '347194', '347195', '347212']
nosy_count = 5.0
nosy_names = ['holdenweb', 'v+python', 'steven.daprano', 'docs@python', 'aldwinaldwin']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue37490'
versions = []

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 mit dem Lesen der Python-Dokumentationseinträge für str.startswith() und str.endswith(), und vergleiche anschließend deren Formulierungen und Beispiele mit dem beabsichtigten Verhalten. Kläre, welche Informationen fehlen oder irreführend sind, aktualisiere die relevante Dokumentation und überprüfe, dass beide Einträge ihre Verwendung konsistent erklären.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

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