Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix prelude module docs inconsistency #9559

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Fix prelude module docs inconsistency #9559

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c962ca0
fix prelude module docs inconsistency
tguichaoua Aug 24, 2023
4037978
cargo fmt
tguichaoua Aug 24, 2023
3d63ec3
allow missing docs on preludes
tguichaoua Aug 27, 2023
a35a342
cargo fmt
tguichaoua Aug 30, 2023
bb0ea96
Merge branch 'main' into fix-docs/preludes
tguichaoua Aug 30, 2023
5acd9e9
remove lines
tguichaoua Aug 31, 2023
11b1118
Merge branch 'main' into fix-docs/preludes
tguichaoua Sep 24, 2023
bff1878
fix conflict resolution error
tguichaoua Sep 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions crates/bevy_asset/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ pub mod meta;
pub mod processor;
pub mod saver;

#[allow(missing_docs)]
pub mod prelude {
#[doc(hidden)]
pub use crate::{
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_core/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ pub use bytemuck::{bytes_of, cast_slice, Pod, Zeroable};
pub use name::*;
pub use task_pool_options::*;

#[allow(missing_docs)]
pub mod prelude {
//! The Bevy Core Prelude.
#[doc(hidden)]
pub use crate::{
DebugName, FrameCountPlugin, Name, TaskPoolOptions, TaskPoolPlugin, TypeRegistrationPlugin,
Expand Down
1 change: 1 addition & 0 deletions crates/bevy_core_pipeline/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ pub mod experimental {
}
}

#[allow(missing_docs)]
pub mod prelude {
#[doc(hidden)]
pub use crate::{
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_ecs/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ use std::any::TypeId;

pub use bevy_ptr as ptr;

/// Most commonly used re-exported types.
#[allow(missing_docs)]
pub mod prelude {
#[doc(hidden)]
#[cfg(feature = "bevy_reflect")]
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_gizmos/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ mod pipeline_2d;
#[cfg(feature = "bevy_pbr")]
mod pipeline_3d;

/// The `bevy_gizmos` prelude.
#[allow(missing_docs)]
pub mod prelude {
#[doc(hidden)]
pub use crate::{gizmos::Gizmos, AabbGizmo, AabbGizmoConfig, GizmoConfig};
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_hierarchy/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ pub use valid_parent_check_plugin::*;
mod query_extension;
pub use query_extension::*;

#[doc(hidden)]
#[allow(missing_docs)]
pub mod prelude {
#[doc(hidden)]
pub use crate::{
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_input/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ pub mod touchpad;
pub use axis::*;
pub use input::*;

/// Most commonly used re-exported types.
#[allow(missing_docs)]
pub mod prelude {
#[doc(hidden)]
pub use crate::{
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_log/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ mod android_tracing;
static GLOBAL: tracy_client::ProfiledAllocator<std::alloc::System> =
tracy_client::ProfiledAllocator::new(std::alloc::System, 100);

#[allow(missing_docs)]
pub mod prelude {
//! The Bevy Log Prelude.
#[doc(hidden)]
pub use bevy_utils::tracing::{
debug, debug_span, error, error_span, info, info_span, trace, trace_span, warn, warn_span,
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_math/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ pub use affine3::*;
pub use ray::Ray;
pub use rects::*;

/// The `bevy_math` prelude.
#[allow(missing_docs)]
pub mod prelude {
#[doc(hidden)]
pub use crate::{
Expand Down
1 change: 1 addition & 0 deletions crates/bevy_pbr/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ pub use prepass::*;
pub use render::*;
pub use ssao::*;

#[allow(missing_docs)]
pub mod prelude {
#[doc(hidden)]
pub use crate::{
Expand Down
2 changes: 2 additions & 0 deletions crates/bevy_render/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ pub mod settings;
mod spatial_bundle;
pub mod texture;
pub mod view;

#[allow(missing_docs)]
pub mod prelude {
#[doc(hidden)]
pub use crate::{
Expand Down
1 change: 1 addition & 0 deletions crates/bevy_scene/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ pub use scene_filter::*;
pub use scene_loader::*;
pub use scene_spawner::*;

#[allow(missing_docs)]
pub mod prelude {
#[doc(hidden)]
pub use crate::{
Expand Down
1 change: 1 addition & 0 deletions crates/bevy_sprite/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ mod texture_atlas_builder;

pub mod collide_aabb;

#[allow(missing_docs)]
pub mod prelude {
#[doc(hidden)]
pub use crate::{
Expand Down
1 change: 1 addition & 0 deletions crates/bevy_text/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ pub use pipeline::*;
pub use text::*;
pub use text2d::*;

#[allow(missing_docs)]
pub mod prelude {
#[doc(hidden)]
pub use crate::{Font, Text, Text2dBundle, TextAlignment, TextError, TextSection, TextStyle};
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_time/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ use bevy_ecs::system::{Res, ResMut};
use bevy_utils::{tracing::warn, Duration, Instant};
use crossbeam_channel::{Receiver, Sender};

#[allow(missing_docs)]
pub mod prelude {
//! The Bevy Time Prelude.
#[doc(hidden)]
pub use crate::{fixed_timestep::FixedTime, Time, Timer, TimerMode};
}
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_transform/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ pub mod components;
/// Systems responsible for transform propagation
pub mod systems;

#[doc(hidden)]
#[allow(missing_docs)]
pub mod prelude {
#[doc(hidden)]
pub use crate::{
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_ui/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ pub use render::*;
pub use ui_node::*;
use widget::UiImageSize;

#[doc(hidden)]
#[allow(missing_docs)]
pub mod prelude {
#[doc(hidden)]
pub use crate::{
Expand Down
1 change: 1 addition & 0 deletions crates/bevy_window/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ pub use event::*;
pub use system::*;
pub use window::*;

#[allow(missing_docs)]
pub mod prelude {
#[doc(hidden)]
pub use crate::{
Expand Down