Skip to content

Clean formatting in io.rs #1167

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
ojeda opened this issue May 29, 2025 · 1 comment
Open

Clean formatting in io.rs #1167

ojeda opened this issue May 29, 2025 · 1 comment
Labels
easy Expected to be an easy issue to resolve. good first issue Good for newcomers • lib Related to the `rust/` library.

Comments

@ojeda
Copy link
Member

ojeda commented May 29, 2025 •
edited
Loading

We don't use @ to refer to parameters or similar in Rust documentation. Also, it is missing a code span.

This requires submitting a proper patch to the LKML and the Rust for Linux mailing list. Please recall to test your changes (including generating the documentation if changed, running the Rust doctests if changed, etc.), to use a proper title for the commit, to sign your commit under the Developer's Certificate of Origin and to add a Reported-by: tag, a Closes: tag to this issue and a Fixes: tag to the relevant commit. Please see https://docs.kernel.org/process/submitting-patches.html and https://rust-for-linux.com/contributing for details.
@ojeda ojeda added • lib Related to the `rust/` library. good first issue Good for newcomers easy Expected to be an easy issue to resolve. labels May 29, 2025
@saivishnu725
Copy link

Sent a patch

intel-lab-lkp pushed a commit to intel-lab-lkp/linux that referenced this issue May 30, 2025
@saivishnu725 @intel-lab-lkp
rust: doc: Clean up formatting in io.rs
028bb95 
Replace `@` with backticks in a comment of `io.rs` to follow Rust doc
convention

Reported-by: Miguel Ojeda <[email protected]>
Closes: Rust-for-Linux#1167
Signed-off-by: Sai Vishnu M <[email protected]>
intel-lab-lkp pushed a commit to intel-lab-lkp/linux that referenced this issue Jun 3, 2025
@saivishnu725 @intel-lab-lkp
rust: doc: Clean up formatting in io.rs
65330f4 
Removed reference to internal variables in the comment of `IoMem`
This avoids using private variable names in public documentation.

Reported-by: Miguel Ojeda <[email protected]>
Closes:  Rust-for-Linux#1167

Signed-off-by: Sai Vishnu M <[email protected]>
intel-lab-lkp pushed a commit to intel-lab-lkp/linux that referenced this issue Jun 3, 2025
@saivishnu725 @intel-lab-lkp
rust: doc: Clean up formatting in io.rs
0e355f6 
Removed reference to internal variables in the comment of `IoMem`
This avoids using private variable names in public documentation.

Reported-by: Miguel Ojeda <[email protected]>
Closes:  Rust-for-Linux#1167
Signed-off-by: Sai Vishnu M <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
easy Expected to be an easy issue to resolve. good first issue Good for newcomers • lib Related to the `rust/` library.
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ojeda @saivishnu725