apache/beam

Annotate code references inside inline documentation in Python-SDK

Offen

#18.232 geöffnet am 03.06.2022

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Java (4.097 Forks)batch import
P3coregood first issueimprovementpython

Repository-Metriken

Stars
 (7.313 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Some of the inline documentation in Python-SDK contains references to classes, methods or fields. The document generation tool (Sphinx) supports annotating such code blocks.

If the inline documentation is annotated properly then the references will be linked (clickable) on the generated site.

Relevant Sphinx documentation: http://www.sphinx-doc.org/en/stable/markup/inline.html#xref-syntax

Imported from Jira BEAM-1756. Original Jira may contain additional context. Reported by: tibor.kiss@gmail.com.

Contributor Guide

Research-Richtung
Fügen Sie Sphinx Querverweis Markup (z. B. :class:, :meth:, :func:) zur Inline Dokumentation im Quellcode des Python SDK hinzu, um Referenzen auf der generierten Dokumentationsseite anklickbar zu machen.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonSphinx
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90