AlgebraicJulia/Catlab.jl

Clean up API docs for stable modules

Open

#48 aperta il 28 set 2019

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

Metriche repository

Star
 (706 star)
Metriche merge PR
 (Nessuna PR mergiata 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
Inizia rivedendo la documentazione API corrente per i moduli stabili menzionati nell'issue. Segui le convenzioni per le docstring di Julia e le funzionalità di Documenter.jl come @ref e @id. Esamina la documentazione esistente nel repository per degli esempi. Non esistono ancora PR o commenti collegati; questo è un compito aperto pronto per un contributore.
Tech stack
Nessuno
Dominio
documentationapi
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JuliaDocumenter.jlMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75