AlgebraicJulia / AlgebraicJulia/Catlab.jl

Clean up API docs for stable modules

未關閉
#48 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
docs good first issue
主要語言
Julia
星號
724
分支
73
PR 合併指標
30 天內沒有已合併 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](https://docs.julialang.org/en/v1/manual/documentation/index.html) and using [Documenter.jl features](https://juliadocs.github.io/Documenter.jl/stable/man/syntax/) such as `@ref` and `@id`, which I have not been consistently doing.

貢獻指南

開啟貢獻指南

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。