Skip to content

Commit 4bf7b97

Browse files
paddymillsojeda
authored andcommitted
rust: make section names plural
Clean Rust documentation section headers to use plural names. Suggested-by: Miguel Ojeda <ojeda@kernel.org> Link: #1110 Signed-off-by: Patrick Miller <paddymills@proton.me> Link: https://lore.kernel.org/r/20241002022749.390836-1-paddymills@proton.me [ Removed the `init` one that doesn't apply anymore and reworded slightly. - Miguel ] Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
1 parent eb71fea commit 4bf7b97

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

rust/kernel/list/arc.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -464,7 +464,7 @@ where
464464

465465
/// A utility for tracking whether a [`ListArc`] exists using an atomic.
466466
///
467-
/// # Invariant
467+
/// # Invariants
468468
///
469469
/// If the boolean is `false`, then there is no [`ListArc`] for this value.
470470
#[repr(transparent)]

rust/kernel/sync/arc.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -492,7 +492,7 @@ impl<T: ?Sized> From<Pin<UniqueArc<T>>> for Arc<T> {
492492
/// There are no mutable references to the underlying [`Arc`], and it remains valid for the
493493
/// lifetime of the [`ArcBorrow`] instance.
494494
///
495-
/// # Example
495+
/// # Examples
496496
///
497497
/// ```
498498
/// use kernel::sync::{Arc, ArcBorrow};

rust/macros/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ pub fn concat_idents(ts: TokenStream) -> TokenStream {
263263
/// literals (lifetimes and documentation strings are not supported). There is a difference in
264264
/// supported modifiers as well.
265265
///
266-
/// # Example
266+
/// # Examples
267267
///
268268
/// ```
269269
/// # const binder_driver_return_protocol_BR_OK: u32 = 0;

0 commit comments

Comments
 (0)