Prevent tags from loc #50220
Merged
Prevent tags from loc #50220
Conversation
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
gewarren
requested review from
a team,
BillWagner,
IEvangelist and
adegeo
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This PR systematically updates documentation formatting to prevent XML tags from being localized. The changes ensure XML/HTML tags are properly marked with backticks (`<tag>`) instead of backslash escapes (\<tag>), which prevents localization tools from translating the tag names themselves.
Key Changes:
- Converted all escaped XML tags to backtick-formatted code tags (
`<summary>`instead of\<summary>) - Removed trailing whitespace from YAML frontmatter fields (f1_keywords, helpviewer_keywords)
- Cleaned up trailing spaces in code blocks and prose text
- Updated keyboard input formatting to use semantic HTML (
<kbd>Enter</kbd>)
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/csharp/misc/cs1723.md | Updated XML tag references and cleaned trailing whitespace |
| docs/csharp/misc/cs1712.md | Reformatted XML tag references and removed trailing spaces |
| docs/csharp/misc/cs1592.md | Updated <include> tag reference to backtick format |
| docs/csharp/misc/cs1590.md | Updated <include> tag reference to backtick format |
| docs/csharp/misc/cs1589.md | Updated <include> tag reference to backtick format |
| docs/csharp/misc/cs1574.md | Converted <exception> tag reference from escaped to backtick format |
| docs/csharp/misc/cs1570.md | Updated multiple XML tag references (<exception>, <seealso>, <include>) to backtick format |
| docs/csharp/language-reference/xmldoc/recommended-tags.md | Systematically converted all section headers and tag references from escaped format to backticks |
| docs/csharp/language-reference/compiler-options/index.md | Updated <compiler> element reference to backtick format |
| docs/csharp/language-reference/compiler-messages/cs1705.md | Updated <dependentAssembly> element reference (partial - other tags still use backslashes) |
| docs/core/unmanaged-api/debugging/icordebug/icordebugprocess6-enablevirtualmodulesplitting-method.md | Converted interface name references to backtick format |
| docs/core/tutorials/library-with-visual-studio-code.md | Updated keyboard input to use semantic <kbd> tag |
| docs/core/tools/dependencies.md | Updated <PackageReference> heading to backtick format |
| docs/core/extensions/best-practices-for-developing-world-ready-apps.md | Updated <globalization> element reference to backtick format |
| docs/core/deploying/runtime-store.md | Updated XML element references (<TargetManifestFiles>, <PublishWithAspNetCoreTargetManifest>) to backtick format |
| docs/core/compatibility/serialization/7.0/binaryformatter-apis-produce-errors.md | Updated heading and references to <EnableUnsafeBinaryFormatterSerialization> to backtick format |
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Contributes to #50193.
Internal previews
Toggle expand/collapse