JuliaLang/julia

Include all public docstrings in the manual

Open

#19,529 opened on 2016年12月7日

GitHub で見る
 (8 comments) (2 reactions) (0 assignees)Julia (48,709 stars) (5,773 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.
Include all public docstrings in the manual · JuliaLang/julia#19529 | Good First Issue