AlgebraicJulia/Catlab.jl

Clean up API docs for stable modules

开放

#48 创建于 2019年9月28日

在 GitHub 查看贡献者指南
 (0 条评论) (0 个反应) (0 位负责人)Julia (68 个派生)batch import
docsgood first issue

仓库指标

星标
 (706 个星标)
PR 合并指标
 (平均合并 17天 19小时) (30 天内合并 2 个 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.

贡献者指南

研究方向
检查接线图模块中的现有文档字符串，并按照Julia文档字符串约定和Documenter.jl功能（如@ref和@id）进行更新。
技术栈
julia
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
JuliaGit
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75