Anders429 / Anders429/brood

Full Documentation tracking issue

Aperta
#72 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
C - Documentation C - Tracking Issue
Lingua principale
Rust
Stelle
41
Fork
2
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Tracking issue for fully documenting all items in the library.

"All items" includes everything, both public and private. Up to this point, everything that is public has been documented. However, private items are not documented. This issue essentially just tracks this private item documentation.

Note that private item documentation is a goal because it makes maintainability and extensibility of the library that much easier.

As modules are completely documented, they should be checked off below:

- [ ] archetype
- [ ] identifier
- [ ] impl_serde.rs
- [ ] iter.rs
- [ ] mod.rs
- [ ] impl_debug.rs
- [ ] impl_drop.rs
- [ ] impl_eq.rs
- [ ] impl_send.rs
- [ ] impl_serde.rs
- [ ] mod.rs
- [ ] archetypes
- [ ] impl_debug.rs
- [ ] impl_eq.rs
- [ ] impl_serde.rs
- [ ] iter.rs
- [ ] mod.rs
- [ ] par_iter.rs
- [ ] entities
- [ ] seal
- [ ] length.rs
- [ ] mod.rs
- [ ] storage.rs
- [ ] mod.rs
- [ ] entity
- [ ] allocator
- [ ] impl_serde.rs
- [ ] location.rs
- [ ] locations.rs
- [ ] mod.rs
- [ ] slot.rs
- [ ] identifier
- [ ] impl_serde.rs
- [ ] mod.rs
- [ ] seal
- [ ] mod.rs
- [ ] storage.rs
- [ ] mod.rs
- [ ] query
- [ ] filter
- [ ] mod.rs
- [ ] seal.rs
- [ ] result
- [ ] iter.rs
- [ ] mod.rs
- [ ] par_iter.rs
- [ ] view
- [ ] par
- [ ] seal
- [ ] mod.rs
- [ ] repeat.rs
- [ ] mod.rs
- [ ] assertion_buffer.rs
- [ ] mod.rs
- [ ] seal.rs
- [ ] claim.rs
- [ ] mod.rs
- [ ] registry
- [ ] seal
- [ ] assertions.rs
- [ ] length.rs
- [ ] mod.rs
- [ ] storage.rs
- [ ] debug.rs
- [ ] eq.rs
- [ ] mod.rs
- [ ] send.rs
- [ ] serde.rs
- [ ] sync.rs
- [ ] system
- [ ] schedule
- [ ] raw_task
- [ ] mod.rs
- [ ] seal.rs
- [ ] stage
- [ ] mod.rs
- [ ] seal.rs
- [ ] builder.rs
- [ ] mod.rs
- [ ] sendable.rs
- [ ] task.rs
- [ ] mod.rs
- [ ] null.rs
- [ ] par.rs
- [ ] world
- [ ] entry.rs
- [ ] impl_debug.rs
- [ ] impl_default.rs
- [ ] impl_eq.rs
- [ ] impl_send.rs
- [ ] impl_serde.rs
- [ ] impl_sync.rs
- [ ] mod.rs
- [ ] component.rs
- [ ] doc.rs
- [ ] hlist.rs
- [ ] lib.rs
- [ ] macro.rs
- [ ] reexports.rs

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.