Skip to content

Commit c33529f

Browse files
authored
Assorted polish for lib.rs (#21386)
Improve grammar, clarity, and documentation style in lib.rs
1 parent 419e733 commit c33529f

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

src/lib.rs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
)]
66
//! [![Bevy Logo](https://bevy.org/assets/bevy_logo_docs.svg)](https://bevy.org)
77
//!
8-
//! Bevy is an open-source modular game engine built in Rust, with a focus on developer productivity
8+
//! Bevy is an open-source, modular game engine built in Rust, with a focus on developer productivity
99
//! and performance.
1010
//!
1111
//! Check out the [Bevy website](https://bevy.org) for more information, read the
@@ -14,7 +14,7 @@
1414
//!
1515
//! ## Example
1616
//!
17-
//! Here is a simple "Hello World" Bevy app:
17+
//! Here is a simple "Hello, World!" Bevy app:
1818
//! ```
1919
//! use bevy::prelude::*;
2020
//!
@@ -29,19 +29,19 @@
2929
//! }
3030
//! ```
3131
//!
32-
//! Don't let the simplicity of the example above fool you. Bevy is a [fully featured game engine](https://bevy.org)
32+
//! Don't let the simplicity of the example above fool you. Bevy is a [fully featured game engine](https://bevy.org),
3333
//! and it gets more powerful every day!
3434
//!
3535
//! ## This Crate
3636
//!
37-
//! The `bevy` crate is just a container crate that makes it easier to consume Bevy subcrates.
38-
//! The defaults provide a "full" engine experience, but you can easily enable / disable features
37+
//! The `bevy` crate is a container crate that makes it easier to consume Bevy subcrates.
38+
//! The defaults provide a "full engine" experience, but you can easily enable or disable features
3939
//! in your project's `Cargo.toml` to meet your specific needs. See Bevy's `Cargo.toml` for a full
40-
//! list of features available.
40+
//! list of available features.
4141
//!
42-
//! If you prefer, you can also consume the individual bevy crates directly.
42+
//! If you prefer, you can also use the individual Bevy crates directly.
4343
//! Each module in the root of this crate, except for the prelude, can be found on crates.io
44-
//! with `bevy_` appended to the front, e.g. `app` -> [`bevy_app`](https://docs.rs/bevy_app/*/bevy_app/).
44+
//! with `bevy_` appended to the front, e.g., `app` -> [`bevy_app`](https://docs.rs/bevy_app/*/bevy_app/).
4545
#![doc = include_str!("../docs/cargo_features.md")]
4646
#![doc(
4747
html_logo_url = "https://bevy.org/assets/icon.png",
@@ -56,6 +56,6 @@ pub use bevy_internal::*;
5656
#[expect(
5757
unused_imports,
5858
clippy::single_component_path_imports,
59-
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."
59+
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."
6060
)]
6161
use bevy_dylib;

0 commit comments

Comments
 (0)