AlgebraicJulia/Catlab.jl

Clean up API docs for stable modules

Open

#48 opened on Sep 28, 2019

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Julia (68 forks)batch import
docsgood first issue

Repository metrics

Stars
 (706 stars)
PR merge metrics
 (Avg merge 17d 19h) (2 merged PRs in 30d)

Description

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 direction
Study the existing docstrings in the wiring diagrams module and update them to follow Julia docstring conventions and Documenter.jl features like @ref and @id.
Tech stack
julia
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JuliaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75