docs: add code fences to Example: docstring blocks#2104
Merged
Kludex merged 1 commit intomodelcontextprotocol:mainfrom Feb 19, 2026
Merged
docs: add code fences to Example: docstring blocks#2104Kludex merged 1 commit intomodelcontextprotocol:mainfrom
Example: docstring blocks#2104Kludex merged 1 commit intomodelcontextprotocol:mainfrom
Conversation
Docstrings using `Example:` sections had indented code without triple-backtick fences, causing mkdocs to render them as prose paragraphs instead of code blocks. - Wrap all unfenced example code in `python ... ` blocks - Rename `Example usage:` and `Example Usage:` to `Example:` so griffe recognizes them as proper docstring sections - Normalize `Examples:` (plural) to `Example:` (singular) for consistent mkdocs rendering - Split multi-example blocks into separate fenced blocks with prose labels where appropriate (`_httpx_utils.py`, `server.py`, `experimental.py`, `task_support.py`)
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
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.
Docstrings using
Example:sections had indented code without triple-backtick fences, causing mkdocs to render them as prose paragraphs instead of code blocks.python ...blocksExample usage:andExample Usage:toExample:so griffe recognizes them as proper docstring sectionsExamples:(plural) toExample:(singular) for consistent mkdocs rendering_httpx_utils.py,server.py,experimental.py,task_support.py)