Skip to content

Commit 6f7c554

Browse files
authored
Fix common capitalization errors in documentation (bevyengine#14562)
WASM -> Wasm MacOS -> macOS Nothing important, just something that annoyed me for a while :)
1 parent bfcb19a commit 6f7c554

File tree

33 files changed

+51
-51
lines changed

33 files changed

+51
-51
lines changed

.cargo/config_fast_builds.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
#
88
# ## LLD
99
#
10-
# LLD is a linker from the LLVM project that supports Linux, Windows, MacOS, and WASM. It has the greatest
10+
# LLD is a linker from the LLVM project that supports Linux, Windows, macOS, and Wasm. It has the greatest
1111
# platform support and the easiest installation process. It is enabled by default in this file for Linux
12-
# and Windows. On MacOS, the default linker yields higher performance than LLD and is used instead.
12+
# and Windows. On macOS, the default linker yields higher performance than LLD and is used instead.
1313
#
1414
# To install, please scroll to the corresponding table for your target (eg. `[target.x86_64-pc-windows-msvc]`
1515
# for Windows) and follow the steps under `LLD linker`.
@@ -25,7 +25,7 @@
2525
# your corresponding target, disable LLD by commenting out its `-Clink-arg=...` line, and enable Mold by
2626
# *uncommenting* its `-Clink-arg=...` line.
2727
#
28-
# There is a fork of Mold named Sold that supports MacOS, but it is unmaintained and is about the same speed as
28+
# There is a fork of Mold named Sold that supports macOS, but it is unmaintained and is about the same speed as
2929
# the default ld64 linker. For this reason, it is not included in this file.
3030
#
3131
# For more information, please see Mold's repository at <https://github.com/rui314/mold>.
@@ -142,7 +142,7 @@ rustflags = [
142142
]
143143

144144
# Optional: Uncommenting the following improves compile times, but reduces the amount of debug info to 'line number tables only'
145-
# In most cases the gains are negligible, but if you are on macos and have slow compile times you should see significant gains.
145+
# In most cases the gains are negligible, but if you are on macOS and have slow compile times you should see significant gains.
146146
# [profile.dev]
147147
# debug = 1
148148

.github/actions/install-linux-deps/action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# repository before you can use this action.
1313
#
1414
# This action will only install dependencies when the current operating system is Linux. It will do
15-
# nothing on any other OS (MacOS, Windows).
15+
# nothing on any other OS (macOS, Windows).
1616

1717
name: Install Linux dependencies
1818
description: Installs the dependencies necessary to build Bevy on Linux.

.github/start-wasm-example/tests/wasm_example.spec.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ test.beforeEach(async ({ page }) => {
66

77
const MAX_TIMEOUT_FOR_TEST = 300_000;
88

9-
test.describe('WASM example', () => {
9+
test.describe('Wasm example', () => {
1010
test('Wait for success', async ({ page }, testInfo) => {
1111
let start = new Date().getTime();
1212

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ jobs:
7272
run: cargo run -p ci -- lints
7373

7474
miri:
75-
# Explicity use MacOS 14 to take advantage of M1 chip.
75+
# Explicity use macOS 14 to take advantage of M1 chip.
7676
runs-on: macos-14
7777
timeout-minutes: 60
7878
steps:
@@ -231,7 +231,7 @@ jobs:
231231
232232
233233
run-examples-macos-metal:
234-
# Explicity use MacOS 14 to take advantage of M1 chip.
234+
# Explicity use macOS 14 to take advantage of M1 chip.
235235
runs-on: macos-14
236236
timeout-minutes: 30
237237
steps:

.github/workflows/validation-jobs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ jobs:
209209
npx playwright install --with-deps
210210
cd ../..
211211
212-
- name: First WASM build
212+
- name: First Wasm build
213213
run: |
214214
cargo build --release --example ui --target wasm32-unknown-unknown
215215

Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@ reflect_functions = ["bevy_internal/reflect_functions"]
354354
[dependencies]
355355
bevy_internal = { path = "crates/bevy_internal", version = "0.15.0-dev", default-features = false }
356356

357-
# WASM does not support dynamic linking.
357+
# Wasm does not support dynamic linking.
358358
[target.'cfg(not(target_family = "wasm"))'.dependencies]
359359
bevy_dylib = { path = "crates/bevy_dylib", version = "0.15.0-dev", default-features = false, optional = true }
360360

@@ -760,7 +760,7 @@ doc-scrape-examples = true
760760
name = "Lines"
761761
description = "Create a custom material to draw 3d lines"
762762
category = "3D Rendering"
763-
# WASM does not support the `POLYGON_MODE_LINE` feature.
763+
# Wasm does not support the `POLYGON_MODE_LINE` feature.
764764
wasm = false
765765

766766
[[example]]

clippy.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
doc-valid-idents = [
22
"GilRs",
33
"glTF",
4-
"MacOS",
4+
"macOS",
55
"NVidia",
66
"OpenXR",
77
"sRGB",

crates/bevy_app/src/panic_handler.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//! This module provides panic handlers for [Bevy](https://bevyengine.org)
2-
//! apps, and automatically configures platform specifics (i.e. WASM or Android).
2+
//! apps, and automatically configures platform specifics (i.e. Wasm or Android).
33
//!
44
//! By default, the [`PanicHandlerPlugin`] from this crate is included in Bevy's `DefaultPlugins`.
55
//!
@@ -11,7 +11,7 @@ use crate::Plugin;
1111

1212
/// Adds sensible panic handlers to Apps. This plugin is part of the `DefaultPlugins`. Adding
1313
/// this plugin will setup a panic hook appropriate to your target platform:
14-
/// * On WASM, uses [`console_error_panic_hook`](https://crates.io/crates/console_error_panic_hook), logging
14+
/// * On Wasm, uses [`console_error_panic_hook`](https://crates.io/crates/console_error_panic_hook), logging
1515
/// to the browser console.
1616
/// * Other platforms are currently not setup.
1717
///

crates/bevy_asset/src/io/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
#[cfg(all(feature = "file_watcher", target_arch = "wasm32"))]
22
compile_error!(
33
"The \"file_watcher\" feature for hot reloading does not work \
4-
on WASM.\nDisable \"file_watcher\" \
5-
when compiling to WASM"
4+
on Wasm.\nDisable \"file_watcher\" \
5+
when compiling to Wasm"
66
);
77

88
#[cfg(target_os = "android")]

crates/bevy_asset/src/io/wasm.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ extern "C" {
2323
fn worker(this: &Global) -> JsValue;
2424
}
2525

26-
/// Reader implementation for loading assets via HTTP in WASM.
26+
/// Reader implementation for loading assets via HTTP in Wasm.
2727
pub struct HttpWasmAssetReader {
2828
root_path: PathBuf,
2929
}

0 commit comments

Comments
 (0)