docs: convert RST code-block directives in docstrings to Markdown - #132
Merged
Conversation
Follow-up to #130. mkdocstrings renders docstrings as Markdown, so the leftover `.. code-block:: python` directives in Example: sections were showing up literally on the API pages instead of rendering as code blocks. Converts all 9 occurrences (simple.py, base.py, local.py) to fenced ```python blocks. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Follow-up to #130. mkdocstrings renders docstrings as Markdown, so the leftover
.. code-block:: pythondirectives insideExample:sections were showing up literally on the API reference pages instead of rendering as syntax-highlighted code blocks.This converts all 9 occurrences (2 in
simple.py, 3 inbase.py, 4 inlocal.py) to fenced```pythonblocks, and ruff picked up a couple of adjacent formatting normalizations.Test plan
grep -rn "code-block" dte_adj/returns 0 hitscd docs && uv run mkdocs build --strictbuilds cleanly🤖 Generated with Claude Code