JuliaLang/julia

Include all public docstrings in the manual

Open

#19,529 创建于 2016年12月7日

在 GitHub 查看
 (8 评论) (2 反应) (0 负责人)Julia (48,709 star) (5,773 fork)batch import
docsdocsystemhelp wanted

描述

Currently there are a significant number (200+) docstrings in Base and it's submodules that are not included in the manual anywhere. To see the current list of docstrings that still need to be included change the following line in doc/make.jl

    checkdocs = :none,

to

    checkdocs = :all,

and build the docs with

make docs

from the root directory.

There's some docstrings for names that are exported and should definitely find there way into the manual somewhere, as well as quite a few internal docstrings that probably don't need to be included or could do with some improvements before inclusion.

(I'm marking this issue as up-for-grabs since it can readily be distributed between many contributors.)

贡献者指南

技术栈
无
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Basic Julia knowledgeAbility to build Julia documentation from source
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75
研究方向
Begin by modifying the file `doc/make.jl` to set `checkdocs = :all` instead of `:none`, then build the documentation using `make docs` from the root directory. This will generate a list of all docstrings not currently included in the manual. For each docstring, determine whether it is exported (public) and should be added to the appropriate manual page. For internal docstrings, assess if they need revision or can be omitted. The issue is marked as up for grabs, so contributors can focus on a subset of docstrings. Review any existing comments for guidance on which docstrings to prioritize.