Fix View doc string #2551
Merged
Fix View doc string #2551
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
aabmass
added
doc
codeboten
approved these changes
Mar 24, 2022
ocelotl
approved these changes
Mar 24, 2022
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
Sphinx expects constructors to be documented in the class's docstring, not the
__init__method's. Move theView.__init__docstring to the class as Sphinx is expecting. Otherwise, the documentation doesn't get generated.Type of change
Please delete options that are not relevant.
n/a
How Has This Been Tested?
n/a
Does This PR Require a Contrib Repo Change?
Checklist: