JuliaLang/julia

Better documentation of stdlibs

Open

#28,712 创建于 2018年8月16日

在 GitHub 查看
 (20 评论) (4 反应) (0 负责人)Julia (48,709 star) (5,773 fork)batch import
docsgood first issue

描述

A lot of functionality has been moved from Base to stdlibs. However, for people who haven't been part of this process (especially beginners) it is not really transparent which stdlibs exist and what their purpose is.

The documentation doesn't seem to contain a list of all stdlibs with short descriptions. I think such a list would be very useful as a compact overview of all stdlibs.

The only kind of overview is the navigation pane. There, however, names do not match actual stdlib names and short descriptions are missing.

  1. Do people agree that such a list would be good to have?
  2. Where should such a table go?

贡献者指南

技术栈
无
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
basic Julia knowledgefamiliarity with Julia's stdlib structure
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60
研究方向
Review the existing documentation structure in Julia's repository, especially the `doc/` directory. Look at the current navigation pane and list of stdlibs. Discuss in the issue (comments) to decide on location and format. Propose a table of stdlibs with short descriptions to be added to the documentation.