Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tickets/dm-14908: Convert package to numpydoc format #60

Merged
merged 3 commits into from Dec 18, 2018

Conversation

isullivan
Copy link
Member

No description provided.

Copy link
Member Author

@isullivan isullivan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I can't explicitly approve this pull request, since I created it.

@@ -20,6 +20,8 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#

__all__ = ("RawAndFlatContainer", "RawAndFlatAssembler", "RawAndFlatDisassembler")
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like the other packages use a list for __all__ , so I would recommend a list here for consistency.

----------
md : `lsst.daf.base.PropertySet`
Image metadata.
`dict`
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing argDict?

Dataset identifier
Returns
-------
result : str
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

str


Returns
-------
`lsst.afw.image.VisitInfo`
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here and below, include a name for the return.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. That used to be optional but I guess it isn't any longer.

@r-owen r-owen merged commit 6e41885 into master Dec 18, 2018
@r-owen r-owen deleted the tickets/DM-14908 branch December 18, 2018 00:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants