fix(docs): replace RST :func: role with Markdown in configure_distributed_tracing docstring - #249
Merged
Merged
Conversation
…istributed_tracing docstring The Sphinx :func: role renders as raw RST text in the autogenerated MDX published to the docs site. Replace with plain backtick syntax so the generated http_instrumentation.mdx renders correctly. Spotted in agent-observability-docs PR #68 review. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
pradystar
approved these changes
Sep 17, 2026
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
:func:\instrument_distributed_tracing`with ``instrument_distributed_tracing()`` in theconfigure_distributed_tracingdocstring insrc/splunk_ao/http_instrumentation.py`:func:role is not supported in the MDX doc pipeline and renders as raw text in the published docs siteContext
Spotted during review of agent-observability-docs #68 by @sheilattran8. The
sdk-api/python/reference/http_instrumentation.mdxfile is autogenerated — fixing the source docstring here is the right path; docs will self-correct on the next SDK publish.Test plan
src/splunk_ao/http_instrumentation.pyline 280 no longer contains:func:sdk-api/python/reference/http_instrumentation.mdxline 54 renders correctly in the docs site🤖 Generated with Claude Code