python / python/cpython

Make 'rt' the default for open in docs

Offen
#84,562 2 Kommentare 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 40382
Nosy @terryjreedy, @facundobatista

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 2020-04-24.20:16:00.259>
labels = ['type-feature', '3.9', 'docs']
title = "Make 'rt' the default for open in docs"
updated_at = <Date 2020-05-01.20:43:05.171>
user = 'https://github.com/facundobatista'

bugs.python.org fields:

activity = <Date 2020-05-01.20:43:05.171>
actor = 'terry.reedy'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-04-24.20:16:00.259>
creator = 'facundobatista'
dependencies = []
files = []
hgrepos = []
issue_num = 40382
keywords = []
message_count = 2.0
messages = ['367219', '367885']
nosy_count = 3.0
nosy_names = ['terry.reedy', 'facundobatista', 'docs@python']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue40382'
versions = ['Python 3.9']

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

Durchsuche die CPython-Dokumentation nach Verweisen auf open und seinen Standardmodus, beginnend mit dem Quelldokument der Dokumentation statt mit Implementierungscode. Aktualisiere die relevante Formulierung so, dass der Standard als 'rt' dokumentiert wird, und überprüfe anschließend, dass die betroffenen Dokumentationsbeispiele und die API-Beschreibung konsistent 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
35/100

Neue Issues direkt in Ihr Postfach

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