AlgebraicJulia/Catlab.jl

Clean up API docs for stable modules

Aberta

#48 aberto em 28 de set. de 2019

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)Julia (68 forks)batch import
docsgood first issue

Métricas do repositório

Stars
 (706 estrelas)
Métricas de merge de PR
 (Mesclagem média 17d 19h) (2 fundiu PRs 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
Estude os docstrings existentes no módulo de diagramas de fiação e atualize os para seguir as convenções de docstring do Julia e os recursos do Documenter.jl, como @ref e @id.
Pilha de tecnologia
julia
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.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JuliaGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75