Overview documentation

Ouverte
#160 4 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
35/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
rust
Domaine
documentation

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
Rust
Étoiles
4.3k
Forks
391
Aucune PR mergée en 30 j

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de rust-ndarray/ndarray

Toutes les issues de rust-ndarray/ndarray

Issues similaires

Plus d'issues Rust

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.