Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Clean up modules

Aperta
#1,566 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
rust
Ambito
developer-experience

Direzione di ricerca

No specific files, tests, or entry points are named. Start by inventorying the ndarray module tree and identifying module-level code and missing documentation; done means the stated module-definition principles are applied consistently, with validation across the affected modules.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

docs good first issue tracking-issue

ndarray has a lot of modules! They tend to be a little hard to read through, and it can be hard to know where code should go when adding or modifying the library. I'd like for us to refactor our codebase to follow a few principles for module definition:

  1. Always have module-level documentation, even for private modules. By telling readers what a module aims to do, we can help contributors know where to add/remove/change code.
  2. Reduce or eliminate most module-level code, opting for just mod ... and ... use ... declarations. This should make it really fast for contributors to figure out how a module is structured.

This is especially important for public modules, but preferably should be applied to private modules, as well.

Lingua principale
Rust
Stelle
4.3k
Fork
391
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di rust-ndarray/ndarray

Tutte le issue di rust-ndarray/ndarray

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.