JuliaMath / JuliaMath/IntelVectorMath.jl

Add documentation pages

Offen
#61 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Julia
Sterne
75
Forks
17
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
julia
Bereich
ci-cd, documentation
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.