AlgebraicJulia/Catlab.jl

Clean up API docs for stable modules

Open

#48 建立於 2019年9月28日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Julia (706 star) (68 fork)batch import
docsgood first issue

描述

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.

貢獻者指南

技術棧
無
領域
documentationapi
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
JuliaDocumenter.jlMarkdown
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75
研究方向
Start by reviewing the current API docs for stable modules mentioned in the issue. Follow the Julia docstring conventions and Documenter.jl features like @ref and @id. Look at existing documentation in the repository for examples. No linked PRs or comments exist yet; this is an open task ready for a contributor.