DM-15162: Improve documentation for DataIdContainer #57
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
parejkoj
reviewed
Jul 20, 2018
| the override class as ``ContainerClass`` for ``add_id_argument``. (If you don't want the argument parser | ||
| to compute data references, you may use this class and specify ``doMakeDataRefList=False`` in | ||
| ``add_id_argument``.) | ||
| **Fields:** |
There was a problem hiding this comment.
Should these be documented in a Parameters block, or should they be declared as class members and documented there?
https://developer.lsst.io/python/numpydoc.html#examples-of-constant-and-class-attribute-docstrings
to 79 character width
especially for `DataIdContainer` and the `level` argument
|
I moved the field documentation and rebased the commit as per your suggestions |
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.
and also clean up some other docs.