JuliaMath / JuliaMath/IntelVectorMath.jl

Add documentation pages

Aperta
#61 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Julia
Stelle
75
Fork
17
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

The current documentation via the Readme is fine, but fairly long, and somewhat incomplete.

This setup should be moved to Documenter.jl, also rebuilding the performance plots when deploying on master, but by default not on MRs.

See https://stackoverflow.com/questions/36191766/metaprogramming-within-docstring-with-eval for adding DocStrings.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Start by reviewing the current README and the requested Documenter.jl migration, then inspect how performance plots are generated and how master builds differ from merge requests. Use the linked metaprogramming reference when evaluating docstrings. Done means the documentation is separated from the README and deployment rebuilds plots only on master.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
julia
Ambito
ci-cd, documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.