From cae22dc3b7f770c3629aebc065e363593ddb209d Mon Sep 17 00:00:00 2001 From: etserend Date: Wed, 16 Sep 2026 10:40:22 -0500 Subject: [PATCH] fix(docs): replace RST :func: role with plain Markdown in configure_distributed_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 --- src/splunk_ao/http_instrumentation.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/splunk_ao/http_instrumentation.py b/src/splunk_ao/http_instrumentation.py index 75371eb4..bd675144 100644 --- a/src/splunk_ao/http_instrumentation.py +++ b/src/splunk_ao/http_instrumentation.py @@ -277,7 +277,7 @@ def configure_distributed_tracing( Notes ----- Repeated calls with the same provider do not attach another Splunk AO span - processor. Use :func:`instrument_distributed_tracing` instead when export + processor. Use `instrument_distributed_tracing()` instead when export has already been configured separately on the provider. This function also wraps the current process-global text-map propagator for session baggage. Install a custom global propagator first; replacing it afterward removes