allow extending NumpyDocString sections #53
Merged
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
Current implementation of NumpyDocString define sections in `self._parsed_data` in `NumpyDocString.__init__()`, which is not convenient for developers to extend this class to add more sections. By setting section definitions as a class static variable, it will be more convenient for developers to extend more sections by changing the class static variable `sections`.
|
I guess the purpose of a documentation standard is, in part, not to be extended. That said, this change is innocuous enough, so I'm ok with it. |
|
Probably should be `self._parsed_data = copy.deepcopy(self.sections)`
because it contains mutable lists.
|
|
@pv already changed to deep copy. |
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.
Current implementation of NumpyDocString define sections in
self._parsed_datainNumpyDocString.__init__(), which is notconvenient for developers to extend this class to add more sections. By
setting section definitions as a class static variable, it will be more
convenient for developers to extend more sections by changing the class
static variable
sections.