AlgebraicJulia/Catlab.jl

Clean up API docs for stable modules

Open

#48 opened on 2019年9月28日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Julia (68 forks)batch import
docsgood first issue

Repository metrics

Stars
 (706 stars)
PR merge metrics
 (30d に merged PR はありません)

説明

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.

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

調査方針
まず、issueで言及されている安定モジュールの現在のAPIドキュメントを確認してください。Juliaのdocstring規約とDocumenter.jlの@refや@idなどの機能に従ってください。リポジトリ内の既存のドキュメントを例として参照してください。まだリンクされたPRやコメントはありません。これはコントリビューターが取り組む準備ができているオープンなタスクです。
技術スタック
なし
領域
documentationapi
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
古い
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
JuliaDocumenter.jlMarkdown
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75