Skip to content

Add some warning entries #5018

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
merged 2 commits into from
Apr 12, 2024

Conversation

Rageking8
Copy link
Contributor

Summary:

  • Add some warnings found that are not documented in the warning list page (found while doing Add links to compiler warnings by compiler version #4988).
  • Add warning codes that don't have a dedicated page to f1_keywords.
  • Remove warning codes that have a dedicated page from f1_keywords.
  • Sync up f1_keywords and helpviewer_keywords.

Note 1) Normalization of table formatting can be done in a separate PR (maybe to the style of compiler-warnings-c4800-through-c4999.md, i.e. with spaces around the table cells).

Note 2) Not sure why article "Compiler warnings C4800 through C5999" has name compiler-warnings-c4800-through-c4999.md (this affects the article link as well).

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 a6d81cc:

✅ Validation status: passed

File Status Preview URL Details
docs/error-messages/compiler-warnings/compiler-warnings-c4400-through-c4599.md ✅Succeeded
docs/error-messages/compiler-warnings/compiler-warnings-c4600-through-c4799.md ✅Succeeded
docs/error-messages/compiler-warnings/compiler-warnings-c4800-through-c4999.md ✅Succeeded

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit 8c96918:

✅ Validation status: passed

File Status Preview URL Details
docs/error-messages/compiler-warnings/compiler-warnings-c4400-through-c4599.md ✅Succeeded
docs/error-messages/compiler-warnings/compiler-warnings-c4600-through-c4799.md ✅Succeeded
docs/error-messages/compiler-warnings/compiler-warnings-c4800-through-c4999.md ✅Succeeded

For more details, please refer to the build report.

For any questions, please:

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.

This is good work. Thank you.

@TylerMSFT
Copy link
Collaborator

#sign-off
Regarding your question about the filename, I imagine what happened is initially the topic was for the range specified but then expanded. Changing a filename means work to add a redirect so it doesn't break user's bookmarks or anything on the internet that now links to the topic. It can be done, but changing the filename probably didn't rate against the constant flow of new work coming at the team.

@Rageking8
Copy link
Contributor Author

#sign-off Regarding your question about the filename, I imagine what happened is initially the topic was for the range specified but then expanded. Changing a filename means work to add a redirect so it doesn't break user's bookmarks or anything on the internet that now links to the topic. It can be done, but changing the filename probably didn't rate against the constant flow of new work coming at the team.

One way to fix that issue is to break that article into 2 or more articles. This way no redirect is needed since the article retains it filename, while the excess warnings can be placed in a new article (keeping to the existing 200 warnings/article chunking). Although there will be no link breakage (or redirects), there will still be that "semantic" difference where someone links to that article but are referring to the C5000+ range, which I would argue is rare and not that impactful.

@TylerMSFT
Copy link
Collaborator

#sign-off
Trying again.

@Court72 Court72 merged commit c533ee8 into MicrosoftDocs:main Apr 12, 2024
@Rageking8 Rageking8 deleted the add-some-warning-entries branch April 14, 2024 09:34
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.

3 participants