[DM-14908] Convert obs_test to numpydoc - Jira

XML

Word

Printable

Details

Type: Story
Status: Done
Resolution: Done
Fix Version/s: None
Component/s: obs_test
Labels:
- numpydoc

Story Points:
6
Epic Link:
s19a-ap-emergent
Team:
Alert Production

Description

Update all the python modules in the obs_test package so they have numpydoc doc strings instead of doxygen. Make sure the entire package sphinx docs can be built.

Useful references:

https://community.lsst.org/t/pipelines-package-docs-hack-day-instructions/2742
--> start at "Beginning the Numpydoc conversion, one module at a time"

https://developer.lsst.io/python/numpydoc.html

Attachments

Issue Links

mentioned in: Page Loading...

Activity

Ascending order - Click to sort in descending order

Hide

Permalink

Ian Sullivan added a comment - 17/Dec/18 5:09 PM

Looks good. I had a few minor comments on the pull request.

Show

Ian Sullivan added a comment - 17/Dec/18 5:09 PM Looks good. I had a few minor comments on the pull request.

Hide

Permalink

Russell Owen added a comment - 17/Dec/18 5:56 PM

Thank you. I made all your suggested improvements, made sure unit tests still passed and docs still built and merged it.

Show

Russell Owen added a comment - 17/Dec/18 5:56 PM Thank you. I made all your suggested improvements, made sure unit tests still passed and docs still built and merged it.

People

Assignee:: Russell Owen

Reporter:: Meredith Rawls

Watchers:: Ian Sullivan, John Swinbank, Jonathan Sick, Meredith Rawls, Russell Owen

Votes:: 0 Vote for this issue

Watchers:: 5 Start watching this issue

Dates

Created:: 26/Jun/18 2:55 PM

Updated:: 17/Dec/18 5:56 PM

Resolved:: 17/Dec/18 5:56 PM

Jenkins

No builds found.

Data Management