Skip to content

Invert section wording about headers to match content - #5938

Merged
ttorble merged 1 commit into
MicrosoftDocs:mainfrom
veganaiZe:patch-1
Jun 15, 2026
Merged

Invert section wording about headers to match content#5938
ttorble merged 1 commit into
MicrosoftDocs:mainfrom
veganaiZe:patch-1

Conversation

@veganaiZe

Copy link
Copy Markdown
Contributor

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".

Clarify intent of section
@prmerger-automator

Copy link
Copy Markdown
Contributor

@veganaiZe : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit c1c92c8:

✅ Validation status: passed

File Status Preview URL Details
docs/cpp/header-files-cpp.md ✅Succeeded

For more details, please refer to the build report.

@v-regandowner

Copy link
Copy Markdown
Contributor

@TylerMSFT

Can you review the proposed changes?

IMPORTANT: When the changes are ready for publication, adding a #sign-off comment is the best way to signal that the PR is ready for the review team to merge.

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

@prmerger-automator prmerger-automator Bot added the aq-pr-triaged Tracking label for the PR review team label Jun 12, 2026

@TylerMSFT TylerMSFT left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Good point. Appreciate the update.

@TylerMSFT

Copy link
Copy Markdown
Collaborator

#sign-off

@ttorble
ttorble merged commit 7dc1ad3 into MicrosoftDocs:main Jun 15, 2026
2 checks passed
@veganaiZe
veganaiZe deleted the patch-1 branch June 15, 2026 16:40
learn-build-service-prod Bot added a commit that referenced this pull request Jun 15, 2026
…//github.com/MicrosoftDocs/cpp-docs (branch main) (#6747)

* Update Vectorized STL algorithm documentation to reflect the current stae (#5937)

Since the last update:
 * ARM64 and ARM64EC vectorization was added. Mention of x64 and x86 is removed, as vectorization is now supported on any target, except deprecated `/clr:pure` and `/clr:safe` modes.
 * `includes` is now manually vectorized too
 * `replace_copy` is now manually vectorized too

Also moved `find_end` to `search` / `search_n` group, where it fits better.

* Update header-files-cpp.md (#5938)

Clarify intent of section

---------

Co-authored-by: learn-build-service-prod[bot] <113403604+learn-build-service-prod[bot]@users.noreply.github.com>
Co-authored-by: Learn Build Service GitHub App <Learn Build Service LearnBuild@microsoft.com>
Co-authored-by: Alex Guteniev <gutenev@gmail.com>
Co-authored-by: veganaiZe <7102064+veganaiZe@users.noreply.github.com>
learn-build-service-prod Bot added a commit that referenced this pull request Jul 8, 2026
…//github.com/MicrosoftDocs/cpp-docs (branch main) (#6756)

* Update Vectorized STL algorithm documentation to reflect the current stae (#5937)

Since the last update:
 * ARM64 and ARM64EC vectorization was added. Mention of x64 and x86 is removed, as vectorization is now supported on any target, except deprecated `/clr:pure` and `/clr:safe` modes.
 * `includes` is now manually vectorized too
 * `replace_copy` is now manually vectorized too

Also moved `find_end` to `search` / `search_n` group, where it fits better.

* Update header-files-cpp.md (#5938)

Clarify intent of section

* Update documentation on accessing System.String characters (#5940)

* Update documentation on accessing System.String characters

Added important note about treating interior pointers as const and linked to unsafe code best practices.

* Update docs/dotnet/how-to-access-characters-in-a-system-string.md

Co-authored-by: Jan Kotas <jkotas@microsoft.com>

* Apply suggestions from code review

Co-authored-by: Aaron R Robinson <arobins@microsoft.com>

* Apply suggestions from code review

Co-authored-by: Aaron R Robinson <arobins@microsoft.com>

---------

Co-authored-by: Jan Kotas <jkotas@microsoft.com>

---------

Co-authored-by: learn-build-service-prod[bot] <113403604+learn-build-service-prod[bot]@users.noreply.github.com>
Co-authored-by: Learn Build Service GitHub App <Learn Build Service LearnBuild@microsoft.com>
Co-authored-by: Alex Guteniev <gutenev@gmail.com>
Co-authored-by: veganaiZe <7102064+veganaiZe@users.noreply.github.com>
Co-authored-by: Aaron R Robinson <arobins@microsoft.com>
Co-authored-by: Jan Kotas <jkotas@microsoft.com>
learn-build-service-prod Bot added a commit that referenced this pull request Jul 28, 2026
…//github.com/MicrosoftDocs/cpp-docs (branch main) (#6778)

* Update Vectorized STL algorithm documentation to reflect the current stae (#5937)

Since the last update:
 * ARM64 and ARM64EC vectorization was added. Mention of x64 and x86 is removed, as vectorization is now supported on any target, except deprecated `/clr:pure` and `/clr:safe` modes.
 * `includes` is now manually vectorized too
 * `replace_copy` is now manually vectorized too

Also moved `find_end` to `search` / `search_n` group, where it fits better.

* Update header-files-cpp.md (#5938)

Clarify intent of section

* Update documentation on accessing System.String characters (#5940)

* Update documentation on accessing System.String characters

Added important note about treating interior pointers as const and linked to unsafe code best practices.

* Update docs/dotnet/how-to-access-characters-in-a-system-string.md

Co-authored-by: Jan Kotas <jkotas@microsoft.com>

* Apply suggestions from code review

Co-authored-by: Aaron R Robinson <arobins@microsoft.com>

* Apply suggestions from code review

Co-authored-by: Aaron R Robinson <arobins@microsoft.com>

---------

Co-authored-by: Jan Kotas <jkotas@microsoft.com>

* Clarify version prefix for Visual Studio Command Prompt (#5946)

Updated instructions for starting Visual Studio Command Prompt to reflect changes in version specification.

---------

Co-authored-by: learn-build-service-prod[bot] <113403604+learn-build-service-prod[bot]@users.noreply.github.com>
Co-authored-by: Learn Build Service GitHub App <Learn Build Service LearnBuild@microsoft.com>
Co-authored-by: Alex Guteniev <gutenev@gmail.com>
Co-authored-by: veganaiZe <7102064+veganaiZe@users.noreply.github.com>
Co-authored-by: Aaron R Robinson <arobins@microsoft.com>
Co-authored-by: Jan Kotas <jkotas@microsoft.com>
Co-authored-by: Eric Brumer <ericbr@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants