feat: remove annotations for properties in attributes section of summary #242
Conversation
This file contains 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
elfkuzco
changed the title
elfkuzco
force-pushed
the
remove-annotations-from-attrs-summary
branch
from
856cfbd to
bd596a1
Compare
viktorlashchuk
added a commit
to viktorlashchuk/mkdocstrings-python
that referenced
this pull request
Feb 24, 2025
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.
Rationale
When
summaryis set to True inmkdocs.yml, one-line@propertyattributes are shown as they are without the stripping of the annotation. For examplestr: xxxxxxis shown asstr:xxxxin theAttributessection of the summary. This PR strips out any annotations, effectively leaving thexxxxxxxpart in the summary which is what is desired.Changes
do_as_attributes_sectionto parse the description from the docstring accounting for@propertystyle docstrings too.