Tracking issue: deny missing docs, one crate at a time
- Dominant language
- Rust
- Stars
- 48.2k
- Forks
- 4.8k
- Avg merge
- 3d 22h
- Merged PRs (30d)
- 161
Description
Docs are great! However, it's easy to let them atrophy.
As Bevy grows and stabilizes, we want to be able to turn on `#![warn(missing_docs)]` (which will cause CI to fail if violated). This is helpful because it helpful for new users and contributors, and ensures that our code base's documentation state doesn't regress.
However, not everything is stable or well documented enough to do so already.
We should turn this on one crate at a time, once it hits 100% coverage. If there's a crate
Let's check the current doc coverage.
1. Set the following environment variable (on Windows, I used the [`$Env:` syntax](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_environment_variables?view=powershell-7.2)): `RUSTDOCFLAGS="-Z unstable-options --show-coverage"`
2. Run `cargo +nightly doc --workspace --all-features --no-deps`
Run on 2023-03-14:
**Crate | Docs Coverage**
- [x] `bevy_a11y` | 100.0%
- [x] `bevy_animation` | 100.0%
- [ ] `bevy_utils` | 53.3%
- [x] `bevy_tasks` | 100.0% (#3509)
- [ ] `bevy_derive` | 33%
- [ ] `bevy_macro_utils` | 28.6%
- [x] `bevy_math` | 100.0% (#3503 | #4591)
- [x] `bevy_app` | 100.0% (#3539)
- [ ] `bevy_ecs_macros` | 40.0%
- [ ] `bevy_dynamic_plugin` | 42.9%
- [ ] `bevy_window` | 97.8% (#4333)
- [x] `bevy_crevice` | **100%** (Not our problem)
- [x] `bevy_log` | 100.0%
- [x] `bevy_transform` | 100.0%
- [x] `bevy_core` | 100.0%
- [ ] `bevy_reflect`| 61.7%
- [ ] `bevy_input` | 90.6% (Claimed by @KDecay)
- [ ] `bevy_gilrs` | 0%
- [ ] `bevy_diagnostic` | 50%
- [ ] `bevy_winit` | 56%
- [x] `bevy_audio` | 100.0%
- [ ] `bevy_scene` | 22.1%
- [x] `bevy_asset` | 100.0% (https://github.com/bevyengine/bevy/pull/3536)
- [ ] `bevy_core_pipeline` | 3.4%
- [ ] `bevy_gltf` |16.7%
- [ ] `bevy_sprite` | 30.8%
- [ ] `bevy_ecs` | 79.5%
- [x] `bevy_dylib` | **100%** (warning not yet enabled) (#3515)
- [ ] `bevy_text` | 35.8%
- [ ] `errors` | 66.7%
- [x] `bevy_internal` | 100.0% (#3514)
- [ ] `bevy_pbr` | 37.4%
- [ ] `bevy_ui` | 74.8%
- [ ] `bevy_render` | 48.2%
- [ ] `bevy_core_pipeline` | 22.3%
- [ ] `bevy_derive` | 57.1%
- [ ] `bevy_encase_derive` | 0%
- [x] `bevy_hierarchy` | 100%
- [x] `bevy_log` | 100%
- [ ] `bevy_mikktspace` | 90%
- [x] `bevy_ptr` | 100%
- [ ] `bevy_reflect_derive`| 88.9%
- [ ] `bevy_render_macros` | 25%
- [ ] `bevy_time` | 78.8%
- [ ] `bevy_utils_macros` | 0%
Contributor guide
Assessment
This issue has not been assessed yet.