Skip to content

fix Example header #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix Example header #71

wants to merge 1 commit into from

Conversation

BennoLossin
Copy link
Member

@BennoLossin BennoLossin commented Jun 24, 2025 •
edited
Loading

@vireshk @BennoLossin
rust: Use consistent "# Examples" heading style in rustdoc
6de063e 
[ 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 <[email protected]>
Signed-off-by: Viresh Kumar <[email protected]>
Acked-by: Benno Lossin <[email protected]>
Link: https://lore.kernel.org/r/ddd5ce0ac20c99a72a4f1e4322d3de3911056922.1749545815.git.viresh.kumar@linaro.org
Signed-off-by: Miguel Ojeda <[email protected]>
Signed-off-by: Benno Lossin <[email protected]>
@BennoLossin
Copy link
Member Author

I'm waiting with merging this for the downstream commit hash to be stable.

@BennoLossin BennoLossin marked this pull request as ready for review June 24, 2025 08:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@BennoLossin @vireshk