AlgebraicJulia/Catlab.jl

Clean up API docs for stable modules

Open

#48 geöffnet am 28. Sept. 2019

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Julia (68 Forks)batch import
docsgood first issue

Repository-Metriken

Stars
 (706 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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.

Contributor Guide

Research-Richtung
Beginnen Sie mit der Überprüfung der aktuellen API Dokumentation für die in dem Issue erwähnten stabilen Module. Befolgen Sie die Julia Docstring Konventionen und Documenter.jl Funktionen wie @ref und @id. Sehen Sie sich die vorhandene Dokumentation im Repository als Beispiele an. Es gibt noch keine verknüpften PRs oder Kommentare; dies ist eine offene Aufgabe, die auf einen Beitragenden wartet.
Tech Stack
Keine
Domain
documentationapi
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JuliaDocumenter.jlMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75