Docs style guide: Code Examples, distinguish between the Tutorial and other documentation

Offen

#1,627 erstellt am 24.5.2020 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 4/5
Geschätzter Aufwand: 3-5 Tage
Anfängerfreundlichkeit: 35/100

Issue-Typ: Dokumentation
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: python
Bereich: documentation

Rechercherichtung

Die Payload nennt keine Repository-Datei und keinen Test; beginne damit, den Dokumentationsleitfaden des devguide und dessen Richtlinien für Tutorial-Codebeispiele zu finden. Lies den verlinkten BPO-Issue für die beabsichtigte Unterscheidung und aktualisiere anschließend die relevante Dokumentation so, dass Tutorial-Beispiele klar getrennt von anderer Dokumentation behandelt werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

needs: decision topic-documentation type-feature

BPO	40758
Nosy	@rhettinger, @ChasBelov

^{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-05-24.20:49:25.128>
labels = ['3.8', '3.9', '3.10', 'docs']
title = 'For 7.2.7. Code Examples, distinguish between the Tutorial and other documentation'
updated_at = <Date 2021-03-26.03:23:38.984>
user = 'https://github.com/ChasBelov'

bugs.python.org fields:

activity = <Date 2021-03-26.03:23:38.984>
actor = 'rhettinger'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-05-24.20:49:25.128>
creator = 'Chas Belov'
dependencies = []
files = []
hgrepos = []
issue_num = 40758
keywords = []
message_count = 2.0
messages = ['369825', '389537']
nosy_count = 3.0
nosy_names = ['rhettinger', 'docs@python', 'Chas Belov']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue40758'
versions = ['Python 3.8', 'Python 3.9', 'Python 3.10']

Vorherrschende Sprache: Python
Sterne: 2.1k
Forks: 1k
Ø Merge: 2 T. 12 Std.
Gemergte PRs (30 T.): 12

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus python/devguide

Feature: Document SELinux bind-mount note for local devcontainer usage Offen

type-feature

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

python/devguide#1879 · 1 Kommentar · Erstellt am 13.8.2026
Feature: Add Homebrew as a way to get build dependencies installed on Linux Offen

type-feature

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

python/devguide#1791 · 2 Kommentare · 1 Reaktion · Erstellt am 20.4.2026
Feature: Add instructions about JIT builds Offen

topic-building python type-feature

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100

python/devguide#1620 · 1 Kommentar · Erstellt am 02.8.2025
Update test command on dev guide landing page Offen

needs: decision topic-test type-bug

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100

python/devguide#1171 · 10 Kommentare · Erstellt am 29.9.2023
Explain how to revert maintenance branch commits Offen

topic-dev process type-feature

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100

python/devguide#319 · 4 Kommentare · 3 Reaktionen · Erstellt am 30.1.2018

Alle Issues in python/devguide