Skip to content

Commit 694c06f

Browse files
authored
Inverse missing_docs logic (#11676)
# Objective Currently the `missing_docs` lint is allowed-by-default and enabled at crate level when their documentations is complete (see #3492). This PR proposes to inverse this logic by making `missing_docs` warn-by-default and mark crates with imcomplete docs allowed. ## Solution Makes `missing_docs` warn at workspace level and allowed at crate level when the docs is imcomplete.
1 parent 55493a8 commit 694c06f

File tree

85 files changed

+149
-123
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+149
-123
lines changed

Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ map_flatten = "warn"
4242

4343
[workspace.lints.rust]
4444
unsafe_op_in_unsafe_fn = "warn"
45+
missing_docs = "warn"
4546

4647
[lints]
4748
workspace = true

crates/bevy_a11y/src/lib.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
//! Accessibility for Bevy
22
3-
#![warn(missing_docs)]
43
#![forbid(unsafe_code)]
54

65
use std::sync::{

crates/bevy_animation/src/lib.rs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
//! Animation for the game engine Bevy
22
3-
#![warn(missing_docs)]
4-
53
mod animatable;
64
mod util;
75

crates/bevy_app/src/lib.rs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
//! This crate is about everything concerning the highest-level, application layer of a Bevy app.
22
3-
#![warn(missing_docs)]
4-
53
mod app;
64
mod main_schedule;
75
mod plugin;

crates/bevy_asset/macros/src/lib.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// FIXME(3492): remove once docs are ready
2+
#![allow(missing_docs)]
3+
14
use bevy_macro_utils::BevyManifest;
25
use proc_macro::{Span, TokenStream};
36
use quote::{format_ident, quote};

crates/bevy_asset/src/lib.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// FIXME(3492): remove once docs are ready
2+
#![allow(missing_docs)]
3+
14
pub mod io;
25
pub mod meta;
36
pub mod processor;

crates/bevy_audio/src/lib.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
//! ```
2222
2323
#![forbid(unsafe_code)]
24-
#![warn(missing_docs)]
2524

2625
mod audio;
2726
mod audio_output;

crates/bevy_core/src/lib.rs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
#![warn(missing_docs)]
2-
31
//! This crate provides core functionality for Bevy Engine.
42
53
mod name;

crates/bevy_core_pipeline/src/lib.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// FIXME(3492): remove once docs are ready
2+
#![allow(missing_docs)]
3+
14
pub mod blit;
25
pub mod bloom;
36
pub mod contrast_adaptive_sharpening;

crates/bevy_derive/src/lib.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// FIXME(3492): remove once docs are ready
2+
#![allow(missing_docs)]
3+
14
extern crate proc_macro;
25

36
mod app_plugin;

0 commit comments

Comments
 (0)