-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Prevent tags from loc #50219
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
Prevent tags from loc #50219
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR systematically updates documentation to prevent XML/HTML tags from being processed during localization. The changes convert backslash-escaped tags (e.g., \<tag>) to backtick-formatted code tags (e.g., `<tag>`) across 28 documentation files. This formatting change ensures that XML/HTML element names are treated as code and won't be inadvertently translated or processed by localization systems.
Key changes:
- Converts
\<tag>syntax to`<tag>`syntax for inline references to XML/HTML elements - Updates markdown headings that reference XML elements (e.g.,
# \<xmlSerializer> Elementto#Element) - Applies consistent code formatting to element names in tables, lists, and prose
Reviewed changes
Copilot reviewed 27 out of 27 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/visual-basic/programming-guide/program-structure/how-to-create-xml-documentation.md | Formats <summary> tag reference as code |
| docs/visual-basic/programming-guide/program-structure/documenting-your-code-with-xml.md | Formats <param> and <summary> tag references as code |
| docs/visual-basic/programming-guide/language-features/xml/how-to-transform-xml-by-using-linq.md | Formats <Book> and <Description> element references as code |
| docs/visual-basic/programming-guide/language-features/xml/how-to-modify-xml-literals.md | Formats <Price>, <Description>, and <Abstract> element references as code |
| docs/visual-basic/developing-apps/programming/log-info/how-to-write-event-information-to-a-text-file.md | Formats configuration file element references as code |
| docs/visual-basic/developing-apps/customizing-extending-my/packaging-and-deploying-custom-my-extensions.md | Formats <CustomDataSignature> heading as code |
| docs/standard/serialization/xmlserializer-element.md | Updates title, headings, and removes trailing whitespace; formats element references as code |
| docs/standard/serialization/xml-schema-definition-tool-xsd-exe.md | Formats <schema> element references in tables as code; removes trailing whitespace |
| docs/standard/serialization/system-xml-serialization-element.md | Updates title and "See also" section link references to use backticks |
| docs/standard/serialization/schemaimporterextensions-element.md | Updates title, removes trailing whitespace, and formats link references as code |
| docs/standard/serialization/how-to-specify-an-alternate-element-name-for-an-xml-stream.md | Formats <ISBN> and <BookID> tag references as code; removes trailing whitespace |
| docs/standard/serialization/datetimeserialization-element.md | Updates title and formats "See also" section links as code; removes trailing whitespace |
| docs/standard/serialization/add-element-for-schemaimporterextensions.md | Updates title and formats "See also" section links as code; removes trailing whitespace |
| docs/standard/security/security-and-user-input.md | Formats <script> tag reference as code |
| docs/standard/garbage-collection/notifications.md | Formats <gcConcurrent> element reference as code |
| docs/standard/garbage-collection/app-domain-resource-monitoring.md | Formats <appDomainResourceMonitoring> element references as code |
| docs/standard/assembly/index.md | Formats <PackageReference> element reference as code |
| docs/standard/assembly/disable-strong-name-bypass-feature.md | Formats <bypassTrustedAppStrongNames> element reference as code; removes trailing whitespace |
| docs/standard/analyzers/platform-compat-analyzer.md | Formats <SupportedPlatform> element reference as code |
| docs/fundamentals/runtime-libraries/system-xml-schema-xmlschemaset.md | Formats <book>, <author>, <title>, <price>, <first-name>, <last-name>, and <name> element references as code |
| docs/fundamentals/runtime-libraries/system-resources-satellitecontractversionattribute.md | Formats <bindingRedirect> element reference as code |
| docs/fundamentals/runtime-libraries/system-resources-resourcemanager.md | Updates heading <satelliteassemblies> to use backticks |
| docs/fundamentals/runtime-libraries/system-appcontext.md | Formats <AppContextSwitchOverrides>, <runtime>, <Add>, and <appSettings> element references as code |
| docs/fundamentals/code-analysis/style-rules/naming-rules.md | Updates section headings to format placeholders as code |
| docs/fundamentals/code-analysis/style-rules/language-rules.md | Formats <AnalysisLevel> property reference as code |
| docs/fundamentals/code-analysis/configuration-options.md | Formats <AnalysisMode>, <AnalysisLevel>, and related property references as code |
| docs/fsharp/language-reference/xml-documentation.md | Formats <namespacedoc> tag reference as code |
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
BillWagner
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This also LGTM @gewarren
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributes to #50193.
Internal previews
Toggle expand/collapse
<dateTimeSerialization>Element<system.xml.serialization>Element<xmlSerializer>Element