Fix docstring formatting for Sphinx compatibility#156
Merged
Conversation
|
|
- Make all attribute descriptions in IOModelOptions use consistent multi-line formatting to avoid RST definition list parsing issues - Add docstrings to config model classes that were missing them, preventing inherited pydantic BaseModel docstrings (which use Markdown syntax) from being displayed 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
robtaylor
force-pushed
the
fix/docstring-warnings
branch
from
082f17d to
03c8dbb
Compare
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
1 participant
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
IOModelOptionsuse consistent multi-line formattingNotes
The remaining warnings in chipflow-docs related to this repo are:
BaseModeldocstrings which use Markdown syntax. These can't be fixed in chipflow-lib - they would need to be suppressed in the docs build or addressed upstream in pydantic.Interfacecross-reference warnings: These occur because multiple classes share the same name (e.g.,amaranth_soc.csr.bus.Interface,amaranth.lib.stream.Interface). These can be fixed by using fully-qualified names in docstrings or suppressing them in Sphinx config.Test plan
IOModelOptionsdefinition list warnings are resolved🤖 Generated with Claude Code