JuliaLang/julia

Include all public docstrings in the manual

Open

#19.529 aperta il 7 dic 2016

Vedi su GitHub
 (8 commenti) (2 reazioni) (0 assegnatari)Julia (5773 fork)batch import
docsdocsystemhelp wanted

Metriche repository

Star
 (48.709 star)
Metriche merge PR
 (Merge medio 20g 6h) (157 PR mergiate in 30 g)

Descrizione

Currently there are a significant number (200+) docstrings in Base and it's submodules that are not included in the manual anywhere. To see the current list of docstrings that still need to be included change the following line in doc/make.jl

    checkdocs = :none,

to

    checkdocs = :all,

and build the docs with

make docs

from the root directory.

There's some docstrings for names that are exported and should definitely find there way into the manual somewhere, as well as quite a few internal docstrings that probably don't need to be included or could do with some improvements before inclusion.

(I'm marking this issue as up-for-grabs since it can readily be distributed between many contributors.)

Guida contributor

Direzione di ricerca
Inizia modificando il file `doc/make.jl` per impostare `checkdocs = :all` invece di `:none`, quindi costruisci la documentazione usando `make docs` dalla directory principale. Questo genererà un elenco di tutte le docstring attualmente non incluse nel manuale. Per ogni docstring, determina se è esportata (pubblica) e dovrebbe essere aggiunta alla pagina appropriata del manuale. Per le docstring interne, valuta se necessitano di revisione o possono essere omesse. L'issue è contrassegnata come up for grabs, quindi i contributori possono concentrarsi su un sottoinsieme di docstring. Rivedi eventuali commenti esistenti per indicazioni su quali docstring dare priorità.
Tech stack
Nessuno
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.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitJulia basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75