Skip to content

Commit

Permalink
wgpu-types: Improve formatting of docs (#7125)
Browse files Browse the repository at this point in the history
  • Loading branch information
waywardmonkeys authored Feb 13, 2025
1 parent c39d37f commit 7fe8e38
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 55 deletions.
2 changes: 1 addition & 1 deletion wgpu-types/src/features.rs
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ macro_rules! bitflags_array {
Self { $($lower_inner_name: self.$lower_inner_name.complement(),)* }
}

/// Calls [Self::insert] if `set` is true and otherwise calls [Self::remove].
/// Calls [`Self::insert`] if `set` is true and otherwise calls [`Self::remove`].
pub fn set(&mut self, other:Self, set: bool) {
$(self.$lower_inner_name.set(other.$lower_inner_name, set);)*
}
Expand Down
4 changes: 2 additions & 2 deletions wgpu-types/src/instance.rs
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ impl InstanceFlags {

/// Infer decent defaults from the build type.
///
/// If cfg!(debug_assertions) is true, then this returns [`Self::debugging()`].
/// If `cfg!(debug_assertions)` is true, then this returns [`Self::debugging()`].
/// Otherwise, it returns [`Self::empty()`].
#[must_use]
pub fn from_build_config() -> Self {
Expand All @@ -146,7 +146,7 @@ impl InstanceFlags {
/// - If the environment variable is not present, then the flag retains its initial value.
///
/// For example `let flags = InstanceFlags::debugging().with_env();` with `WGPU_VALIDATION=0`
/// does not contain `InstanceFlags::VALIDATION`.
/// does not contain [`InstanceFlags::VALIDATION`].
///
/// The environment variables are named after the flags prefixed with "WGPU_". For example:
/// - `WGPU_DEBUG`
Expand Down
Loading

0 comments on commit 7fe8e38

Please sign in to comment.