AlgebraicJulia/Catlab.jl

Clean up API docs for stable modules

Aperta

#48 aperta il 28 set 2019

Vedi su GitHubGuida contributor
 (0 commenti) (0 reazioni) (0 assegnatari)Julia (68 fork)batch import
docsgood first issue

Metriche repository

Star
 (706 stelle)
Metriche merge PR
 (Merge medio 17g 19h) (2 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Studia i docstring esistenti nel modulo dei diagrammi di cablaggio e aggiornali per seguire le convenzioni dei docstring di Julia e le funzionalità di Documenter.jl come @ref e @id.
Tech stack
julia
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JuliaGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75