AlgebraicJulia/Catlab.jl

Clean up API docs for stable modules

オープン

#48 opened on 2019/09/28

GitHub で見るコントリビューターガイド
 (0 件のコメント) (0 件のリアクション) (0 人の担当者)Julia (68 件のフォーク)batch import
docsgood first issue

Repository metrics

Stars
 (706 個のスター)
PR merge metrics
 (平均マージ 17d 19h) (30d で 2 merged PRs)

説明

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.

コントリビューターガイド

調査方針
配線図モジュールの既存のdocstringを調査し、Juliaのdocstring規則とDocumenter.jlの機能（@refや@idなど）に従って更新してください。
技術スタック
julia
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
JuliaGit
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75