# meas_extensions_convolved is undocumented

XMLWordPrintable

#### Details

• Type: Story
• Status: Done
• Resolution: Done
• Fix Version/s: None
• Component/s:
• Labels:
None
• Story Points:
2
• Team:
Data Release Production

#### Description

Please add at least a README file providing a short summary of its functionality and some bare-bones documentation on how to enable and use it.

#### Activity

Hide
Paul Price added a comment - - edited

John Swinbank, would you please check that this has everything you desire?

 price@price-laptop:~/LSST/meas/extensions/convolved (tickets/DM-7896=) $git sub commit ba7059268b249e218538d63f56e49987c39c8a91 Author: Paul Price  Date: Wed Oct 5 13:39:52 2016 -0400    Create README    README.md | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++  1 file changed, 86 insertions(+)  Show Paul Price added a comment - - edited John Swinbank , would you please check that this has everything you desire? price@price-laptop:~/LSST/meas/extensions/convolved (tickets/DM-7896=)$ git sub commit ba7059268b249e218538d63f56e49987c39c8a91 Author: Paul Price <price@astro.princeton.edu> Date: Wed Oct 5 13:39:52 2016 -0400   Create README   README.md | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+)
Hide
John Swinbank added a comment -

Paul Price: This documentation is a model of clarity — thank you very much!

My only significant concern is whether this should all go in the README file, or if it would be more appropriate for the detailed documentation (configuration parameters, output columns, etc) to appear in Doxygen. Perhaps Jonathan Sick has an opinion on this?

I'd also prefer to see README files in reST rather than Markdown for consistency with other documentation. That's what https://developer.lsst.io/docs/package_docs.html#readme-rst asks for, but that document hasn't been formally agreed yet. I don't think it's worth your while spending time converting until & unless the project converges on a standard.

Show
John Swinbank added a comment - Paul Price : This documentation is a model of clarity — thank you very much! My only significant concern is whether this should all go in the README file, or if it would be more appropriate for the detailed documentation (configuration parameters, output columns, etc) to appear in Doxygen. Perhaps Jonathan Sick has an opinion on this? I'd also prefer to see README files in reST rather than Markdown for consistency with other documentation. That's what https://developer.lsst.io/docs/package_docs.html#readme-rst asks for, but that document hasn't been formally agreed yet. I don't think it's worth your while spending time converting until & unless the project converges on a standard.
Hide
Jonathan Sick added a comment -

This package makes me so happy! Clear readme, great numpydoc.

Arguably the README will be a more convenient resoruce in the interim than the Doxygen site, too

I could see the key config parameters being documented as parameters of ConvolvedFluxConfig and ConvolvedFluxData for the output columns. However, I wouldn't necessarily worry about this right now since we've still got to figure out the format for task docs.

Since meas_extensions_convolved is so far along, I'll be able to use it as a prototype for defining how we lay out task docs in Sphinx (this cycle).

Show
Jonathan Sick added a comment - This package makes me so happy! Clear readme, great numpydoc. Arguably the README will be a more convenient resoruce in the interim than the Doxygen site, too I could see the key config parameters being documented as parameters of ConvolvedFluxConfig and ConvolvedFluxData for the output columns. However, I wouldn't necessarily worry about this right now since we've still got to figure out the format for task docs. Since meas_extensions_convolved is so far along, I'll be able to use it as a prototype for defining how we lay out task docs in Sphinx (this cycle).
Hide
Paul Price added a comment -

This package makes me so happy!

I'm going to take that as permission to merge the docs as-is.

Show
Paul Price added a comment - This package makes me so happy! I'm going to take that as permission to merge the docs as-is.
Hide
John Swinbank added a comment -

Show
John Swinbank added a comment -
Hide
Paul Price added a comment -

Merged to master.

Show
Paul Price added a comment - Merged to master.

#### People

Assignee:
Paul Price
Reporter:
John Swinbank
Reviewers:
John Swinbank
Watchers:
John Swinbank, Jonathan Sick, Paul Price