Autogenerate Attribute docstrings - #5246
Merged
harshil21 merged 25 commits intoJun 16, 2026
Merged
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
Or two rather
the folder it's in is already private
aelkheir
reviewed
Jun 15, 2026
aelkheir
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
Apologies for the overdue review! Changes look pretty good to me. I left some minor comments
One thing that's sad is dropping the historical .. versionchanged notes :') but not a big problem git still has them.
Sorry, something went wrong.
Comment thread
docs/auxil/attribute_inserter.py
Outdated
Comment thread
docs/auxil/sphinx_hooks.py
Comment thread
docs/auxil/sphinx_hooks.py
Comment thread
docs/auxil/attribute_inserter.py
Comment thread
changes/unreleased/5240.iJXyH8RNWNNQpC47SfNHzw.toml
Outdated
| pull_requests = [ | ||
| { uid = "5240", author_uids = ["harshil21", "Poolitzer"] }, | ||
| { uid = "5241", author_uids = ["harshil21"] }, | ||
| { uid = "5245", author_uids = ["harshil21"] }, |
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
Suggested change
| { uid = "5245", author_uids = ["harshil21"] }, | |
| { uid = "5246", author_uids = ["harshil21"] }, |
are the other two PRs relevant to this?
Sorry, something went wrong.
Copy link
Copy Markdown
Member
Author
There was a problem hiding this comment.
I will just correct this in the new doc fixes changelog note
Sorry, something went wrong.
Comment thread
docs/auxil/attribute_inserter.py
Comment thread
docs/auxil/bot_insertion.py
Outdated
aelkheir
approved these changes
Jun 16, 2026
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Closes #5242
Took the time to write a full blown docstring parser to do this. So far I've found it pretty reliable since it caught quite a few missing / malformed docstrings.
One thing I changed: the |tupleclassattrs| and |sequenceclassargs| versionchanged notes were deleted. I did this because they were done for v20.0 and it's been many years since that. That way we can unify the argument and attribute docstring.
I manually checked the docs for most edge cases and confirmed that they are correctly handled. Feel free to build the docs and check a random page's to compare the before and after.
AI assisted disclosure: The tests were >90% written by AI (I looked over all of them, and they were quite satisfactory). It also did some of the parser/insertion logic, which I later fine tuned when I found edge cases / logic errors.
Merge after #5241