Introductory documentation

オープン

#462 2018年6月3日に作成コメント 6 件リアクション 3 件担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度: 5/5
見積もり時間: 1週間以上
初心者へのやさしさ: 25/100

issue の種類: ドキュメント
明瞭さ: 説明が足りない
活発さ: 停滞
技術スタック: rust
領域: documentation

調査の方向性

Start by reviewing the existing reference documentation, the concerns in issues #160 and #327, and the ndarray for NumPy users guide cited in the issue. Done would be a separate high-level overview that explains ndarray's structure and design principles while gradually introducing the library to newcomers.

索引モデルが issue の本文から書いたものです。

説明

I was reasoning around this during the last few days while working on my PRs (and reading some issues like #160): it is really complicated to get a good overview of the way ndarray is structured solely relying on the reference documentation. It is even more complicated when the method you are looking at calls functions that are annotated with #[doc(hidden)] (it happens quite often in the core structs and traits implementations)

Without @jturner314's ndarray for NumPy users it would have taken me at least twice as long to reach my current level of understanding (which is still very partial). This echoes #327, for instance.

Would it be of interest to produce some kind of separate documentation, similar in spirit to http://nalgebra.org/ for nalgebra or http://scikit-learn.org/stable/ for scikit-learn?
A high-level overview of the overall crate, aimed at explaining the underlying design principles, gradually introducing a newcomer to the library.
I would be happy to work on it, at least to further my own understanding of ndarray.
What are your thoughts on the matter @bluss?

主要言語: Rust
スター: 4.3k
フォーク: 391
PR マージ指標: 30日以内にマージされた PR はありません

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
リポジトリをフォークし、ブランチを切って変更します。
issue 番号を参照したプルリクエストを送ります。

rust-ndarray/ndarray のほかの issue

.is_all_nan() returns true for an all-finite array オープン

難易度 2/5 1〜3時間初心者へのやさしさ 72/100

rust-ndarray/ndarray#1612 · コメント 1 件 · 2026年8月8日に作成
failed Send inference with ndarray v0.17 and uom 0.38 オープン

難易度 4/5 3〜5日初心者へのやさしさ 48/100

rust-ndarray/ndarray#1617 · コメント 1 件 · 2026年9月9日に作成
Stack overflow in `triu` オープン

bug good first issue

難易度 3/5 1〜2日初心者へのやさしさ 68/100

rust-ndarray/ndarray#1615 · コメント 1 件 · 2026年9月8日に作成
Type covariance absent when used in struct オープン

難易度 4/5 3〜5日初心者へのやさしさ 48/100

rust-ndarray/ndarray#1610 · 2026年7月27日に作成
Empty Array lead to "The strides must not allow any element to be referenced by two different indices" オープン

難易度 3/5 1〜2日初心者へのやさしさ 72/100

rust-ndarray/ndarray#1609 · 2026年7月23日に作成

rust-ndarray/ndarray の issue をすべて見る

似ている issue

test(runtime): narration fixture builds ResolvedContextLimits with budget above window オープン

risk:low runtime status:in-progress type:test

難易度 1/5 1時間未満初心者へのやさしさ 92/100

zeroclaw-labs/zeroclaw#11023 · 2026年9月21日に作成
Refactor traits.rs so that it is only traits オープン

good first issue refactor

難易度 2/5 1〜3時間初心者へのやさしさ 72/100

bcgit/bc-rust#148 · 2026年9月21日に作成
RES: clear actor function state on deregistration オープン

難易度 2/5 1〜3時間初心者へのやさしさ 84/100

EricSpencer00/Resilient#4835 · コメント 1 件 · 2026年9月21日に作成
docs(skills): document `refresh --get` for cross-machine stack reconciliation オープン

agent:ready documentation

難易度 2/5 1〜3時間初心者へのやさしさ 88/100

cesarferreira/stax#890 · 2026年9月21日に作成
asn1grep.py: small error message bug in reporting not-found type オープン

bug

難易度 1/5 1時間未満初心者へのやさしさ 90/100

EFForg/rayhunter#1161 · コメント 1 件 · 2026年9月20日に作成

Rust の issue をもっと見る