Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
ignore people names in
NOTE(<name>)
commentsRelated links
Parent Issue/PR:
None
Links to the definitions of the words added:
A widely seen way of writing comments with names attached.
https://github.com/search?q=%22%2F%2F+NOTE%28%22+language%3AC%2B%2B&type=code&l=C%2B%2B
Compared to normal comments, this is useful because it makes it clear who is responsible for the comment.
Here, I am not adding this pattern because I want to ignore NOTE comments, but to ignore
<name>
inNOTE(<name>)
.Notes for reviewers
Some people using
NOTE(<name>)
for taking notes with their own names.https://github.com/search?q=org%3Aautowarefoundation+NOTE%28&type=code
my dictionary maintaining policy for personal names
When I was maintaining
tier4/autoware-spell-check-dict
, my maintaining policy for people name was as follows:tier4/cspell-dicts
.cspell: ignore <name>
in the code.