Autogenerate Attribute docstrings#5246
Open
harshil21 wants to merge 14 commits into
Open
Conversation
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.
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 we can unify the argument and attribute docstring.
I manually checked most edge cases and confirmed that they show on the docs. 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