Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-7896

meas_extensions_convolved is undocumented

    XMLWordPrintable

Details

    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.

      Attachments

        Issue Links

          Activity

            price Paul Price added a comment - - edited

            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(+)
            

            price Paul Price added a comment - - edited 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(+)

            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 jsick 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.

            swinbank John Swinbank added a comment - 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 jsick 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.

            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).

            jsick 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).
            price 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.

            price 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.
            price Paul Price added a comment -

            Merged to master.

            price Paul Price added a comment - Merged to master.

            People

              price Paul Price
              swinbank John Swinbank
              John Swinbank
              John Swinbank, Jonathan Sick, Paul Price
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Jenkins

                  No builds found.