Skip to content

Tweaks for C6030 warning page #5203

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.

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

Conversation

Rageking8
Copy link
Contributor

Summary:

  • Remove extra space character in header
  • Add links for [[noreturn]] and __declspec(noreturn)
  • Move "Code analysis name" to its own line (every other instance does it that way)
  • Remove superfluous trailing empty line in both code snippets
  • Format [[ noreturn ]] and the function name (prefer snake case for uniformity)

Copy link
Contributor

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

Copy link
Contributor

Learn Build status updates of commit 423c0f3:

✅ Validation status: passed

File Status Preview URL Details
docs/code-quality/c6030.md ✅Succeeded

For more details, please refer to the build report.

For any questions, please:

@Rageking8
Copy link
Contributor Author

Just noticed that inline code blocks in link text does not affect the rendered output. For example both of these lines would look the same:

[__declspec(noreturn)](https://learn.microsoft.com/en-us/cpp/cpp/noreturn?view=msvc-170)
[`__declspec(noreturn)`](https://learn.microsoft.com/en-us/cpp/cpp/noreturn?view=msvc-170)

However, on GitHub there is a visible difference:

__declspec(noreturn)
__declspec(noreturn)



So should we prefer the former or latter?

@ttorble
Copy link
Contributor

ttorble commented Feb 24, 2025

@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 Feb 24, 2025
@TylerMSFT
Copy link
Collaborator

TylerMSFT commented Feb 24, 2025

Just noticed that inline code blocks in link text does not affect the rendered output. For example both of these lines would look the same:

[__declspec(noreturn)](https://learn.microsoft.com/en-us/cpp/cpp/noreturn?view=msvc-170)
[`__declspec(noreturn)`](https://learn.microsoft.com/en-us/cpp/cpp/noreturn?view=msvc-170)

However, on GitHub there is a visible difference:

__declspec(noreturn) __declspec(noreturn)

So should we prefer the former or latter?

The latter (use backticks). The reason is that the backticks prevent automatic machine translation and we don't want translation to happen here. The automatic translator is often smart enough not to try, but rather than play whack-a-mole trying to outsmart it, I default to using the backticks.

Copy link
Collaborator

@TylerMSFT TylerMSFT left a comment

Choose a reason for hiding this comment

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

Thank you

@TylerMSFT
Copy link
Collaborator

#sign-off

@v-dirichards v-dirichards merged commit fc2b42d into MicrosoftDocs:main Feb 24, 2025
2 checks passed
@Rageking8 Rageking8 deleted the tweaks-for-c6030-warning-page branch February 28, 2025 06:36
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