python / python/cpython

Insufficient description of relative imports in docs.python.org

Offen
#82,690 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

BPO 38509
Nosy @anirudnits

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-10-17.16:38:32.264>
labels = ['type-bug', 'docs']
title = 'Insufficient description of relative imports in docs.python.org'
updated_at = <Date 2019-10-17.16:38:32.264>
user = 'https://github.com/anirudnits'

bugs.python.org fields:

activity = <Date 2019-10-17.16:38:32.264>
actor = 'Aniruddha Bhattacharjee'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-10-17.16:38:32.264>
creator = 'Aniruddha Bhattacharjee'
dependencies = []
files = []
hgrepos = []
issue_num = 38509
keywords = []
message_count = 1.0
messages = ['354851']
nosy_count = 2.0
nosy_names = ['docs@python', 'Aniruddha Bhattacharjee']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue38509'
versions = ['Python 3.6']

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 bei der Dokumentation zu relativen Importen auf docs.python.org und prüfe den Kontext des BPO-Issues 38509. Ermittle, welche Erklärung für Neulinge fehlt, und aktualisiere die entsprechende Dokumentation, damit relative Importe ausreichend und korrekt beschrieben werden.

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

Neue Issues direkt in Ihr Postfach

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