Skip to content

Conversation

@gewarren
Copy link
Contributor

@gewarren gewarren commented Nov 28, 2025

Contributes to #50193.


Internal previews

Toggle expand/collapse
📄 File 🔗 Preview link
docs/fsharp/language-reference/xml-documentation.md Document your code with XML comments
docs/fundamentals/code-analysis/configuration-options.md Configuration options for code analysis
docs/fundamentals/code-analysis/style-rules/language-rules.md Language and unnecessary rules
docs/fundamentals/code-analysis/style-rules/naming-rules.md Defining the 'public_symbols' symbol group
docs/fundamentals/runtime-libraries/system-appcontext.md System.AppContext class
docs/fundamentals/runtime-libraries/system-resources-resourcemanager.md System.Resources.ResourceManager class
docs/fundamentals/runtime-libraries/system-resources-satellitecontractversionattribute.md docs/fundamentals/runtime-libraries/system-resources-satellitecontractversionattribute
docs/fundamentals/runtime-libraries/system-xml-schema-xmlschemaset.md System.Xml.Schema.XmlSchemaSet class
docs/standard/analyzers/platform-compat-analyzer.md Platform compatibility analyzer
docs/standard/assembly/disable-strong-name-bypass-feature.md How to: Disable the strong-name bypass feature
docs/standard/assembly/index.md Assemblies in .NET
docs/standard/garbage-collection/app-domain-resource-monitoring.md "Application Domain Resource Monitoring"
docs/standard/garbage-collection/notifications.md Garbage collection notifications
docs/standard/security/security-and-user-input.md Security and User Input
docs/standard/serialization/add-element-for-schemaimporterextensions.md docs/standard/serialization/add-element-for-schemaimporterextensions
docs/standard/serialization/datetimeserialization-element.md <dateTimeSerialization> Element
docs/standard/serialization/how-to-specify-an-alternate-element-name-for-an-xml-stream.md How to: Specify an Alternate Element Name for an XML Stream
docs/standard/serialization/schemaimporterextensions-element.md " Element"
docs/standard/serialization/system-xml-serialization-element.md <system.xml.serialization> Element
docs/standard/serialization/xml-schema-definition-tool-xsd-exe.md docs/standard/serialization/xml-schema-definition-tool-xsd-exe
docs/standard/serialization/xmlserializer-element.md <xmlSerializer> Element
docs/visual-basic/developing-apps/customizing-extending-my/packaging-and-deploying-custom-my-extensions.md Package and deploy custom My extensions (Visual Basic)
docs/visual-basic/developing-apps/programming/log-info/how-to-write-event-information-to-a-text-file.md How to: Write Event Information to a Text File (Visual Basic)
docs/visual-basic/programming-guide/language-features/xml/how-to-modify-xml-literals.md "How to: Modify XML Literals"
docs/visual-basic/programming-guide/language-features/xml/how-to-transform-xml-by-using-linq.md How to: Transform XML by Using LINQ (Visual Basic)
docs/visual-basic/programming-guide/program-structure/documenting-your-code-with-xml.md docs/visual-basic/programming-guide/program-structure/documenting-your-code-with-xml
docs/visual-basic/programming-guide/program-structure/how-to-create-xml-documentation.md How to: Create XML Documentation in Visual Basic

Copy link
Contributor

Copilot AI left a 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> Element to # 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.

Copy link
Member

@BillWagner BillWagner left a 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>
@gewarren gewarren enabled auto-merge (squash) December 2, 2025 00:39
@gewarren gewarren merged commit 5ba0716 into dotnet:main Dec 2, 2025
9 checks passed
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