python / python/cpython

Cover directory and zipfile execution in __main__ module docs

Offen
#89,312 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

docs type-feature
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
36k
Ø Merge
1 T. 9 Std.
Gemergte PRs (30 T.)
558

Beschreibung

BPO 45149
Nosy @ncoghlan

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 2021-09-09.07:45:42.475>
labels = ['type-feature', 'docs']
title = 'Cover directory and zipfile execution in __main__ module docs'
updated_at = <Date 2022-03-11.14:52:45.711>
user = 'https://github.com/ncoghlan'

bugs.python.org fields:

activity = <Date 2022-03-11.14:52:45.711>
actor = 'petr.viktorin'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2021-09-09.07:45:42.475>
creator = 'ncoghlan'
dependencies = []
files = []
hgrepos = []
issue_num = 45149
keywords = []
message_count = 1.0
messages = ['401440']
nosy_count = 2.0
nosy_names = ['ncoghlan', 'docs@python']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue45149'
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

Suchen Sie die Dokumentation des main-Moduls und überprüfen Sie, wie die Ausführung aus Verzeichnissen und Zip-Dateien derzeit beschrieben wird. Aktualisieren Sie die Dokumentation, sodass beide Ausführungsformen abgedeckt werden, und verifizieren Sie anschließend, dass der resultierende Text sie klar erklärt; im Issue ist keine bestimmte Datei oder kein bestimmter Test genannt.

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

Neue Issues direkt in Ihr Postfach

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