Overview documentation

Aberta
#160 4 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
35/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
rust
Domínio
documentation

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
Rust
Estrelas
4.3k
Forks
391
Nenhum PR com merge em 30d

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de rust-ndarray/ndarray

Todas as issues de rust-ndarray/ndarray

Issues semelhantes

Mais issues de Rust

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.