Skip to content

Commit 18b2726

Browse files
author
KDecay
committed
Document bevy_math (#4591)
# Objective - Part of #3492 ## Solution - Document the `bevy_math` crate and add the `#![warn(missing_docs)]` lint.
1 parent 50a1470 commit 18b2726

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

crates/bevy_math/src/lib.rs

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
1-
pub use glam::*;
1+
//! Provides math types and functionality for the Bevy game engine.
2+
//!
3+
//! The commonly used types are vectors like [`Vec2`] and [`Vec3`],
4+
//! matrices like [`Mat3`] and [`Mat4`] and orientation representations
5+
//! like [`Quat`].
6+
7+
#![warn(missing_docs)]
28

9+
/// The `bevy_math` prelude.
310
pub mod prelude {
411
#[doc(hidden)]
512
pub use crate::{
613
BVec2, BVec3, BVec4, EulerRot, IVec2, IVec3, IVec4, Mat3, Mat4, Quat, UVec2, UVec3, UVec4,
714
Vec2, Vec3, Vec4,
815
};
916
}
17+
18+
pub use glam::*;

0 commit comments

Comments
 (0)