Add discussion of doctesting interactive code examples.

Offen

#1,134 erstellt am 13.7.2023 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

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

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

Rechercherichtung

Lies Documentation/Style Guide/Code Examples und die doctest-Dokumentation, insbesondere die interaktiven Beispiele und die Hinweise zu Direktiven. Prüfe den Docs/Doctest CI-Check und die referenzierten Diskussionen, um die aktuelle Richtlinie zu ermitteln, und füge anschließend eine prägnante Zusammenfassung im bestehenden Abschnitt oder in einem neuen Abschnitt unmittelbar danach hinzu. Als erledigt gilt die Aufgabe, wenn der Leitfaden das erwartete doctest-Verhalten und relevante Direktiven für interaktive Beispiele erklärt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

topic-documentation topic-test type-feature

There have been various discussions about doctesting interactive code examples in the python docs. The consensus has been that it is desirable that they pass. Indeed, CI currently has a (pass-not-required) Tests / Docs / Doctest. (But it seems to be setup to be excessively lenient, passing many errors that are normally caught. Intended? Bug?) There has been additional discussion about use of particular features, such as doctest directives. An example from the doc:

The [ELLIPSIS](https://docs.python.org/3/library/doctest.html#doctest.ELLIPSIS) directive
gives a nice approach for the last example:
>>> C()  # doctest: +ELLIPSIS
<C object at 0x...>

Other people may remember such discussions better. In any case, a summary of current policy should be added either in
Documentation / Style Guide /Code Examples or in a new "Interactive Code Examples and Doctest" section immediately after.

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