Overview documentation
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Dokumentation
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- rust
- Bereich
- documentation
Rechercherichtung
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.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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
- Vorherrschende Sprache
- Rust
- Sterne
- 4.3k
- Forks
- 391
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus rust-ndarray/ndarray
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
rust-ndarray/ndarray#1612 · 1 Kommentar ·
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 48/100
rust-ndarray/ndarray#1617 · 1 Kommentar ·
-
Stack overflow in `triu` Offenbug good first issue
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 68/100
rust-ndarray/ndarray#1615 · 1 Kommentar ·
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 48/100
rust-ndarray/ndarray#1610 ·
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 72/100
rust-ndarray/ndarray#1609 ·
Alle Issues in rust-ndarray/ndarray
Ähnliche Issues
-
risk:low runtime status:in-progress type:test
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 92/100
zeroclaw-labs/zeroclaw#11023 ·
-
good first issue refactor
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 84/100
EricSpencer00/Resilient#4835 · 1 Kommentar ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 74/100
bisq-network/bisq-musig#204 ·
-
agent:ready documentation
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
cesarferreira/stax#890 ·