Correct ExtensiveForm docstring arg order and add missing parameter
#465
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
- Update the docstring of the `ExtensiveForm` class to match the order of arguments in the `__init__` method signature. - Add the missing `all_nodenames` argument to the docstring, using a description consistent with the parent class `SPBase` but styled to match `ExtensiveForm`.
|
Thanks! |
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.
Description
This pull request improves the documentation for the
ExtensiveFormclass by:__init__method signature.all_nodenamesargument to the docstring.Changes Made
ExtensiveFormclass docstring for consistency and completeness.Rationale
The previous docstring was misleading due to:
all_nodenamesargument.These changes enhance the clarity and usability of the documentation, making it easier for developers to understand and use the class.