Skip to content

link bridge: Fix typo of document #141

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

Merged
cathay4t merged 1 commit into from
Dec 24, 2025
Merged

link bridge: Fix typo of document #141

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/link/bridge.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use crate::{
},
};

/// Represent dummy interface.
/// Represent Linux Bridge interface.
Copy link

@gemini-code-assist gemini-code-assist bot Dec 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

While this change is a good correction, the comment can be further improved to align with Rust API documentation guidelines. Doc comments for types should typically be a full sentence ending with a period. Using the third-person singular verb form is also conventional.

Suggested change
/// Represent Linux Bridge interface.
/// Represents a Linux Bridge interface.

/// Example code on creating a linux bridge interface
/// ```no_run
/// use rtnetlink::{new_connection, LinkBridge};
Expand Down