mirror of
https://github.com/bevyengine/bevy.git
synced 2026-05-06 06:06:42 -04:00
Assorted polish for lib.rs (#21386)
Improve grammar, clarity, and documentation style in lib.rs
This commit is contained in:
+9
-9
@@ -5,7 +5,7 @@
|
||||
)]
|
||||
//! [](https://bevy.org)
|
||||
//!
|
||||
//! Bevy is an open-source modular game engine built in Rust, with a focus on developer productivity
|
||||
//! Bevy is an open-source, modular game engine built in Rust, with a focus on developer productivity
|
||||
//! and performance.
|
||||
//!
|
||||
//! Check out the [Bevy website](https://bevy.org) for more information, read the
|
||||
@@ -14,7 +14,7 @@
|
||||
//!
|
||||
//! ## Example
|
||||
//!
|
||||
//! Here is a simple "Hello World" Bevy app:
|
||||
//! Here is a simple "Hello, World!" Bevy app:
|
||||
//! ```
|
||||
//! use bevy::prelude::*;
|
||||
//!
|
||||
@@ -29,19 +29,19 @@
|
||||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! Don't let the simplicity of the example above fool you. Bevy is a [fully featured game engine](https://bevy.org)
|
||||
//! Don't let the simplicity of the example above fool you. Bevy is a [fully featured game engine](https://bevy.org),
|
||||
//! and it gets more powerful every day!
|
||||
//!
|
||||
//! ## This Crate
|
||||
//!
|
||||
//! The `bevy` crate is just a container crate that makes it easier to consume Bevy subcrates.
|
||||
//! The defaults provide a "full" engine experience, but you can easily enable / disable features
|
||||
//! The `bevy` crate is a container crate that makes it easier to consume Bevy subcrates.
|
||||
//! The defaults provide a "full engine" experience, but you can easily enable or disable features
|
||||
//! in your project's `Cargo.toml` to meet your specific needs. See Bevy's `Cargo.toml` for a full
|
||||
//! list of features available.
|
||||
//! list of available features.
|
||||
//!
|
||||
//! If you prefer, you can also consume the individual bevy crates directly.
|
||||
//! If you prefer, you can also use the individual Bevy crates directly.
|
||||
//! Each module in the root of this crate, except for the prelude, can be found on crates.io
|
||||
//! with `bevy_` appended to the front, e.g. `app` -> [`bevy_app`](https://docs.rs/bevy_app/*/bevy_app/).
|
||||
//! with `bevy_` appended to the front, e.g., `app` -> [`bevy_app`](https://docs.rs/bevy_app/*/bevy_app/).
|
||||
#![doc = include_str!("../docs/cargo_features.md")]
|
||||
#![doc(
|
||||
html_logo_url = "https://bevy.org/assets/icon.png",
|
||||
@@ -56,6 +56,6 @@ pub use bevy_internal::*;
|
||||
#[expect(
|
||||
unused_imports,
|
||||
clippy::single_component_path_imports,
|
||||
reason = "This causes bevy to be compiled as a dylib when using dynamic linking, and as such cannot be removed or changed without affecting dynamic linking."
|
||||
reason = "This causes Bevy to be compiled as a dylib when using dynamic linking and therefore cannot be removed or changed without affecting dynamic linking."
|
||||
)]
|
||||
use bevy_dylib;
|
||||
|
||||
Reference in New Issue
Block a user