AlgebraicJulia/Catlab.jl

Clean up API docs for stable modules

Open

#48 创建于 2019年9月28日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Julia (68 fork)batch import
docsgood first issue

仓库指标

Star
 (706 star)
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 and using Documenter.jl features such as @ref and @id, which I have not been consistently doing.

贡献者指南

研究方向
首先查看问题中提到的稳定模块的当前 API 文档。遵循 Julia 文档字符串约定和 Documenter.jl 的功能，如 @ref 和 @id。查看仓库中的现有文档作为示例。目前尚无关联的 PR 或评论；这是一个待贡献者处理的开源任务。
技术栈
无
领域
documentationapi
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
半天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
较久未更新
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
JuliaDocumenter.jlMarkdown
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75