Skip to content

Fix code fence issues in metrics and tracing documentation to prevent over-localization #47586

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jul 25, 2025

This PR fixes code fence issues in the .NET metrics and tracing documentation where type names and other technical terms were being over-localized in non-English versions of the documentation.

Problem

As reported in #43876, technical terms like string, int, Boolean, and instrument type names were being translated/localized when the documentation was viewed in other languages, leading to confusing and incorrect translations. For example:

  • In Czech: Boolean was over-localized
  • In German: string was over-localized
  • In Russian: multiple technical terms were incorrectly translated

Solution

Added code fences (backticks) around all type names in the "Type" column of attribute tables across the metrics documentation files. This prevents these technical terms from being localized while still allowing the descriptive text to be properly translated.

Files Changed

  • built-in-metrics-system-net.md - Fixed all type names in attribute tables (string → string, int → int)
  • built-in-metrics-runtime.md - Fixed all type names in attribute tables
  • built-in-metrics-diagnostics.md - Fixed all type names in attribute tables
  • distributed-tracing-builtin-activities.md - Already properly formatted from previous PR

Example Change

Before:

| `dns.question.name` | string | The name being queried. | `www.example.com` | Always |

After:

| `dns.question.name` | `string` | The name being queried. | `www.example.com` | Always |

This ensures that string won't be translated to local language equivalents while still allowing the description "The name being queried" to be properly localized.

Fixes #43876.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@dotnet-policy-service dotnet-policy-service bot added the okr-quality Content-quality KR: Concerns article defects (bugs), freshness, or build warnings. label Jul 25, 2025
…ackticks

Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] Code fence attribute and instrument type names in Metrics and Tracing docs Fix code fence issues in metrics and tracing documentation to prevent over-localization Jul 25, 2025
@Copilot Copilot AI requested a review from gewarren July 25, 2025 22:50
Copilot finished work on behalf of gewarren July 25, 2025 22:51
@gewarren
Copy link
Contributor

@copilot Are there any instrument names that should be surrounded with backticks?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dotnet-fundamentals/svc okr-quality Content-quality KR: Concerns article defects (bugs), freshness, or build warnings.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Code fence attribute and instrument type names in Metrics and Tracing docs
2 participants