Skip to content

Commit 38419d7

Browse files
vireshkBennoLossin
authored andcommitted
rust: Use consistent "# Examples" heading style in rustdoc
[ Downstream kernel commit b6985083be1deb1f5fa14d160265f57d9ccb42a1 ] Use a consistent `# Examples` heading in rustdoc across the codebase. Some modules previously used `## Examples` (even when they should be available as top-level headers), while others used `# Example`, which deviates from the preferred `# Examples` style. Suggested-by: Miguel Ojeda <ojeda@kernel.org> Signed-off-by: Viresh Kumar <viresh.kumar@linaro.org> Acked-by: Benno Lossin <lossin@kernel.org> Link: https://lore.kernel.org/r/ddd5ce0ac20c99a72a4f1e4322d3de3911056922.1749545815.git.viresh.kumar@linaro.org Signed-off-by: Miguel Ojeda <ojeda@kernel.org> Signed-off-by: Benno Lossin <lossin@kernel.org>
1 parent b04197f commit 38419d7

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -953,7 +953,7 @@ macro_rules! try_init {
953953
/// Asserts that a field on a struct using `#[pin_data]` is marked with `#[pin]` ie. that it is
954954
/// structurally pinned.
955955
///
956-
/// # Example
956+
/// # Examples
957957
///
958958
/// This will succeed:
959959
/// ```

0 commit comments

Comments
 (0)