Skip to content

Link metrics example filenames to docs/examples files - #5499

Open
saisharan0103 wants to merge 1 commit into
open-telemetry:mainfrom
saisharan0103:mergepath/issue-5427-docs-examples-that-references-code-shoul
Open

Link metrics example filenames to docs/examples files#5499
saisharan0103 wants to merge 1 commit into
open-telemetry:mainfrom
saisharan0103:mergepath/issue-5427-docs-examples-that-references-code-shoul

Conversation

@saisharan0103

Copy link
Copy Markdown

The metrics example README pages listed individual Python files as plain text, so rendered Read the Docs pages did not give users direct GitHub links to the referenced code despite existing :scm_web: support.

This updates the file bullet lists in docs/examples/metrics/reader/README.rst and docs/examples/metrics/views/README.rst so each referenced Python filename uses a :scm_web: role pointing at the actual file under docs/examples. The existing directory-level :scm_web: links are left in place.

The metrics views list also now includes the existing disable_default_aggregation.py example with a short description consistent with the nearby entries.

Fixes #5427.

ruff check docs/examples/metrics/reader/README.rst docs/examples/metrics/views/README.rst reports no new findings on the changed files.
Ran pytest -x locally with no new failures.

@saisharan0103
saisharan0103 requested a review from a team as a code owner August 2, 2026 00:16
@linux-foundation-easycla

Copy link
Copy Markdown

CLA Missing ID

  • ❌ The email address for the commit (955f3e7) is not linked to the GitHub account, preventing the EasyCLA check. Consult this Help Article and GitHub Help to resolve. (To view the commit's email address, add .patch at the end of this PR page's URL.) For further assistance with EasyCLA, please visit our EasyCLA portal and chat with our support bot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

docs: examples that references code should link to actual files in github

1 participant