Skip to content

style-guide: Note that we don't account for comments in every possible place #121762

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

style-guide: Note that we don't account for comments in every possible place #121762

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

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/doc/style-guide/src/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,10 @@ given:
The following guidelines for comments are recommendations only, a mechanical
formatter might skip formatting of comments.

The style guide does not account for every possible placement of comments.
Placing a comment in unexpected places (e.g. between `pub` and `fn` in `pub
fn`) may result in suboptimal "best effort" formatting by a formatter.

Prefer line comments (`//`) to block comments (`/* ... */`).

When using line comments, put a single space after the opening sigil.
Expand Down