AlgebraicJulia/Catlab.jl

Clean up API docs for stable modules

Open

#48 aberto em 28 de set. de 2019

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Julia (68 forks)batch import
docsgood first issue

Métricas do repositório

Stars
 (706 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

Certain modules, such as for wiring diagrams, are approaching a reasonable degree of API stability. It would be good to improve the API docs. This means following the Julia docstring conventions and using Documenter.jl features such as @ref and @id, which I have not been consistently doing.

Guia do colaborador

Direção de pesquisa
Comece revisando a documentação da API atual para os módulos estáveis mencionados na issue. Siga as convenções de docstring do Julia e os recursos do Documenter.jl, como @ref e @id. Veja a documentação existente no repositório para exemplos. Ainda não existem PRs ou comentários vinculados; esta é uma tarefa aberta pronta para um contribuidor.
Pilha de tecnologia
None
Domain
documentationapi
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.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JuliaDocumenter.jlMarkdown
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75