DM-36000: Clean up sphinx warnings #291
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
erykoff
approved these changes
Aug 29, 2022
There was a problem hiding this comment.
This is all good, except I'm confused about the developer guide on where to put datatypes for return structs. It seems ambiguous on whether it should be in the middle or at the end: https://developer.lsst.io/python/numpydoc.html#struct-types
|
Now that I've re-read the developer guide I can see that it is somewhat unclear where I'm supposed to put the type in parentheses. At least what I have is better than what was there before and could be construed as being sort of consistent. |
No other config fields seem to use this style.
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.
No description provided.