Invert section wording about headers to match content#5938
Open
veganaiZe wants to merge 1 commit into
Open
Conversation
Clarify intent of section
Contributor
|
@veganaiZe : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
prmerger-automator
Bot
added
Change sent to author
cpp-lang/subsvc
visual-cpp/svc
labels
Contributor
|
Learn Build status updates of commit c1c92c8: ✅ Validation status: passed
For more details, please refer to the build report. |
Contributor
|
Can you review the proposed changes? IMPORTANT: When the changes are ready for publication, adding a #label:"aq-pr-triaged" |
prmerger-automator
Bot
added
the
aq-pr-triaged
TylerMSFT
approved these changes
Jun 13, 2026
TylerMSFT
left a comment
TylerMSFT
left a comment
Collaborator
There was a problem hiding this comment.
Good point. Appreciate the update.
Collaborator
|
#sign-off |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
The section heading for "What to put in a header file" is misleading because all of its content is actually about what to avoid placing in a header file. It can especially be a problem for people skimming through who immediately jump to the bullet-list which, again, are things not to be included in a header.
This PR clarifies the section heading by changing it from "What to put in a header file" to "What to avoid in a header file".