apache/beam

Annotate code references inside inline documentation in Python-SDK

Ouverte

#18 232 ouverte le 3 juin 2022

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Java (4 097 forks)batch import
P3coregood first issueimprovementpython

Métriques du dépôt

Stars
 (7 313 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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.

Guide contributeur

Direction de recherche
Ajoutez du balisage de référence croisée Sphinx (par exemple, :class:, :meth:, :func:) dans la documentation en ligne du code source du SDK Python pour rendre les références cliquables sur le site de documentation généré.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonSphinx
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90