AlgebraicJulia/Catlab.jl

Clean up API docs for stable modules

Offen

#48 geöffnet am 28.09.2019

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

Repository-Metriken

Stars
 (706 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 17T 19h) (2 gemergte 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
Untersuchen Sie die vorhandenen Docstrings im Modul für Schaltpläne und aktualisieren Sie sie, um den Julia Docstring Konventionen und den Documenter.jl Funktionen wie @ref und @id zu entsprechen.
Tech Stack
julia
Domain
documentation
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.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JuliaGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75