DM-13916: Numpydoc conversion for ap_association. #13
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
Debug Sphnix docs. dia_collection.py and assoc_db_sqlite.py do not properly compile.
Clean up function Return docs. Clean numpydocs. Debug Sphnix docs. dia_collection.py and assoc_db_sqlite.py do not properly compile. Completed sphnix-doc build Clean up numpydoc strings.
morriscb
force-pushed
the
tickets/DM-13916
branch
from
38bb54b
to
cfa20b2
Compare
parejkoj
reviewed
Apr 6, 2018
There was a problem hiding this comment.
Thanks for fleshing out so many of those returned struct descriptions!
Handful of comments, the main ones being:
- Check that you have
Returnsinstead ofReturn. - Check that your
Returnshave a description of the returned value. - There are some lingering merge conflict blocks (search all files for "<<<" in case I missed some).
|
|
||
| Parameters | ||
| ---------- | ||
| table_name : str | ||
| table_name : `str` | ||
| Name of the new table to create | ||
|
|
||
| Return |
There was a problem hiding this comment.
This should be Returns. Check this everywhere.
|
|
||
| Returns | ||
| ------- | ||
| lsst.ap.association.DIAObjectCollection | ||
| dia_objects : `lsst.ap.association.DIAObjectCollection` |
There was a problem hiding this comment.
A sentence about what this returned collection is.
| @@ -369,16 +360,17 @@ def _get_dia_objects(self, indexer_indices, expMd=None): | |||
|
|
|||
| Parameters | |||
| ---------- | |||
| indexer_indices : array like of ints | |||
| indexer_indices : `ndarray` of `int`s | |||
There was a problem hiding this comment.
I suspect that array-like of `int`s is more appropriate here, since I'd bet a numpy.ndarray would also work.
|
|
||
| Returns | ||
| ------- | ||
| list of lsst.ap.association.DIAObjects | ||
| dia_objects : `list` of `lsst.ap.association.DIAObjects` |
|
|
||
| Return | ||
| ------ | ||
| bool | ||
| is_contained : `bool` |
| dia_object_schema : `lsst.afw.table.Schema` | ||
| ======= | ||
| `lsst.afw.table.Schema` | ||
| >>>>>>> c8d554a... Clean numpydocs. |
There was a problem hiding this comment.
You've got a lingering merge conflict stuck in here!
| dia_source_schema : `lsst.afw.table.Schema` | ||
| ======= | ||
| `lsst.afw.table.Schema` | ||
| >>>>>>> c8d554a... Clean numpydocs. | ||
| """ |
There was a problem hiding this comment.
Another merge conflict block.
| Optional input SourceRecord containing summary statistics on | ||
| the input SourceCatalog. | ||
|
|
||
| >>>>>>> c8d554a... Clean numpydocs. |
| value : ``record value`` | ||
| ======= | ||
| ``record value`` | ||
| >>>>>>> c8d554a... Clean numpydocs. |
| object. | ||
|
|
||
| Return | ||
| ------ | ||
| n_dia_sources : `int` |
There was a problem hiding this comment.
Removed the return on this one because it is a property.
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.
Create numpydocs and enable sphinx.