apache/beam

Annotate code references inside inline documentation in Python-SDK

Open

#18.232 aberto em 3 de jun. de 2022

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Java (4.097 forks)batch import
P3coregood first issueimprovementpython

Métricas do repositório

Stars
 (7.313 stars)
Métricas de merge de PR
 (Mesclagem média 6d) (243 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Adicione marcação de referência cruzada do Sphinx (por exemplo, :class:, :meth:, :func:) na documentação inline do código fonte do Python SDK para tornar as referências clicáveis no site de documentação gerado.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonSphinx
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90