Repository: bevyengine/bevy
File: crates/bevy_render/src/lib.rs (Rust)

Code before:
//! # Useful Environment Variables
//!
//! `WGPU_DEBUG=1` enables debug labels in release builds\
//! `WGPU_VALIDATION=0` disables validation layers\
//! `WGPU_FORCE_FALLBACK_ADAPTER=1` attempts to force software rendering\
//! `WGPU_ADAPTER_NAME`: select a specific adapter by name\
//! `WGPU_SETTINGS_PRIO=webgl2` uses webgl2 limits\
//! `WGPU_SETTINGS_PRIO=compatibility` uses webgpu limits\
//! `VERBOSE_SHADER_ERROR=1` prints shader defs and entrypoint shaders on wgsl compilation error

#![expect(missing_docs, reason = "Not all docs are written yet, see #3492.")]
#![expect(unsafe_code, reason = "Unsafe code is used to improve performance.")]
#![cfg_attr(
    any(docsrs, docsrs_dep),
    expect(
        internal_features,
        reason = "rustdoc_internals is needed for fake_variadic"
    )
)]
#![cfg_attr(any(docsrs, docsrs_dep), feature(doc_auto_cfg, rustdoc_internals))]
#![doc(
    html_logo_url = "https://bevy.org/assets/icon.png",
    html_favicon_url = "https://bevy.org/assets/icon.png"
)]

#[cfg(target_pointer_width = "16")]
compile_error!("bevy_render cannot compile for a 16-bit platform.");

extern crate alloc;
extern crate core;

// Required to make proc macros work in bevy itself.
extern crate self as bevy_render;


Review comment (bug):
```suggestion
//! Both `bevy_render` and `wgpu` have a number of environment variable options for changing the runtime behavior
//! of both crates. Many of these may be useful in development or release environments. 
//!
//! -  `WGPU_DEBUG=1` enables debug labels in release builds
//! - `WGPU_VALIDATION=0` disables validation layers
//! - `WGPU_FORCE_FALLBACK_ADAPTER=1` attempts to force software rendering
//! - `WGPU_ADAPTER_NAME`: select a specific adapter by name
//! - `WGPU_SETTINGS_PRIO=webgl2` uses webgl2 limits
//! - `WGPU_SETTINGS_PRIO=compatibility` uses webgpu limits
//! - `VERBOSE_SHADER_ERROR=1` prints more detailed information about WGSL compilation errors
```

Code after:
//! # Useful Environment Variables
//!
//! Both `bevy_render` and `wgpu` have a number of environment variable options for changing the runtime behavior
//! of both crates. Many of these may be useful in development or release environments.
//!
//! - `WGPU_DEBUG=1` enables debug labels, which can be useful in release builds.
//! - `WGPU_VALIDATION=0` disables validation layers. This can help with particularly spammy errors.
//! - `WGPU_FORCE_FALLBACK_ADAPTER=1` attempts to force software rendering. This typically matches what is used in CI.
//! - `WGPU_ADAPTER_NAME` allows selecting a specific adapter by name.
//! - `WGPU_SETTINGS_PRIO=webgl2` uses webgl2 limits.
//! - `WGPU_SETTINGS_PRIO=compatibility` uses webgpu limits.
//! - `VERBOSE_SHADER_ERROR=1` prints more detailed information about WGSL compilation errors, such as shader defs and shader entrypoint.

#![expect(missing_docs, reason = "Not all docs are written yet, see #3492.")]
#![expect(unsafe_code, reason = "Unsafe code is used to improve performance.")]
#![cfg_attr(
    any(docsrs, docsrs_dep),
    expect(
        internal_features,
        reason = "rustdoc_internals is needed for fake_variadic"
    )
)]
#![cfg_attr(any(docsrs, docsrs_dep), feature(doc_auto_cfg, rustdoc_internals))]
#![doc(
    html_logo_url = "https://bevy.org/assets/icon.png",
    html_favicon_url = "https://bevy.org/assets/icon.png"
)]

#[cfg(target_pointer_width = "16")]
compile_error!("bevy_render cannot compile for a 16-bit platform.");

extern crate alloc;
extern crate core;