Overview documentation

未关闭
#160 4 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
rust
领域
documentation

调研方向

Compare the crates.io entry with the ndarray module documentation linked in the issue, then review the ArrayBase page for material that should remain detailed. Organize the module overview around what the library does, core examples, design ideas, and links to the main types and traits. Done means the overview gives newcomers a clear starting point without duplicating reference details.

由索引模型根据 Issue 内容生成。

描述

docs enhancement help wanted

I at least often find myself wondering "does ndarray support this? where should I look for it?".

ndarray has not bad reference documentation, but not enough of an overview that points into the reference.

I think overview documentation should explain as soon as possible what the library does, give examples of use of the core features, and relate the core design ideas necessary for using it (including linking to any terms that are going to come up, including the main types, traits etc. The crates.io entry [1] does the first well, but the module documentation [2] is a bit mixed up:

  • Mentions N-dim array
  • Skips forward to defining some main types (without explaining the design)
  • Goes back to state the core features (no examples, though)

I would put all of the overview information in the module docs, leaving details to e.g., the ArrayBase page.

[1] https://crates.io/crates/ndarray
[2] https://bluss.github.io/rust-ndarray/master/ndarray/index.html

主要语言
Rust
星标
4.3k
派生
391
30 天内没有已合并 PR

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

rust-ndarray/ndarray 的其他 Issue

查看 rust-ndarray/ndarray 的全部 Issue

相似的 Issue

更多 Rust Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。