[MNT] - Update docstring handling to do more copying around / reduce copied text#278
Merged
TomDonoghue merged 5 commits intomainfrom Jul 7, 2023
Merged
[MNT] - Update docstring handling to do more copying around / reduce copied text#278TomDonoghue merged 5 commits intomainfrom
TomDonoghue merged 5 commits intomainfrom
Conversation
ryanhammonds
approved these changes
Jul 6, 2023
voytek
approved these changes
Jul 6, 2023
Contributor
voytek
left a comment
There was a problem hiding this comment.
Very nice, I didn't even know this was an option.
Member
Author
I mean, it's sorta a hack - but once you take Python's "everything is an object" thing seriously, then you can treat docstrings as string objects that can be programmatically updated and attached to objects! MNE does something similar, which I think is where I first got the idea here (though we're doing a simpler version). |
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
3 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.
This is an update adding more functionality to programmatically managing docstrings, with the overall goal of being able to copy around docstrings sections automatically instead of copy / pasting in the source code.
This is a somewhat forward looking update (will be more useful / important as we add more objects that may share parameters, etc), but here already gets used with the FOOOFGroup object to copy over sections.
In terms of reviewing, it's mostly annoying string manipulation, and any thoughts are more than welcome - but in terms of evaluating functionality, I checked that this works when building the docsite, which is what I'm largely using to check that this ultimately work:
This is the built docsite page for FOOOFGroup:
This show what the source code page shows (showing the changes are enacted):
