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

meas_base to numpydoc format

    Details

      Description

      Convert meas_base to numpydoc format.

        Attachments

          Issue Links

            Activity

            Hide
            jsick Jonathan Sick added a comment -

            David Staker [X], what's your current status with this ticket? Would you like me to take another look at all or specific parts? Is it ready to go?

            Show
            jsick Jonathan Sick added a comment - David Staker [X] , what's your current status with this ticket? Would you like me to take another look at all or specific parts? Is it ready to go?
            Hide
            swinbank John Swinbank added a comment -

            Hey Jonathan — I spoke to David about this yesterday, actually. He's done a bunch of work across a number of packages which he hasn't got around to pushing yet; I think that includes these, and I hope we'll see an update within a couple of days.

            Show
            swinbank John Swinbank added a comment - Hey Jonathan — I spoke to David about this yesterday, actually. He's done a bunch of work across a number of packages which he hasn't got around to pushing yet; I think that includes these, and I hope we'll see an update within a couple of days.
            Hide
            swinbank John Swinbank added a comment -

            Splitting this ticket. DM-15347 will only handle meas_base; use DM-16824 for meas_algorithms.

            Show
            swinbank John Swinbank added a comment - Splitting this ticket. DM-15347 will only handle meas_base; use DM-16824 for meas_algorithms.
            Hide
            swinbank John Swinbank added a comment - - edited

            A few things to note here:

            • There are now two “introductory” documents: one in doc/lsst.meas.base/intro.rst (which was pre-existing) and one in doc/lsst.meas.base/tasks_and_algorithms.rst (which is ported from Doxygen). There's some duplication between these documents, and they don't necessarily agree on terminology in detail. I think addressing this is outside the scope of this ticket, but have filed DM-17013 to handle this in future.
            • There are two build warnings of the form {{WARNING: Tried to skip objects {'SingleFrameFromGenericPlugin', 'ForcedFromGenericPlugin'}

              in module lsst.meas.base, but they were not present. Ignoring}}. These are due to DM-15461. They're fundamentally harmless, and addressing them would involve either significant work on the Sphinx infrastructure or significant rewriting of the meas_base code. Again, I propose to rule them out of scope for this ticket.

            • When building standalone, there are six warnings generated by :lsst-task: references to tasks in other packages. This is unavoidable with the current documentation system (other than by simply not including these references). I've filed DM-17014 to address this.
            • While the docstrings for Python modules are generally pretty good, I took only a cursory pass through the tests, tweaking formatting and fixing a few typos. Most of the tests have no meaningful docstrings; fixing that would involve allocation substantial effort, and I doubt this will ever be useful.
            • 50 further warnings are generated when building without the DM-11558 branch of pex_config.
            Show
            swinbank John Swinbank added a comment - - edited A few things to note here: There are now two “introductory” documents: one in doc/lsst.meas.base/intro.rst (which was pre-existing) and one in doc/lsst.meas.base/tasks_and_algorithms.rst (which is ported from Doxygen). There's some duplication between these documents, and they don't necessarily agree on terminology in detail. I think addressing this is outside the scope of this ticket, but have filed DM-17013 to handle this in future. There are two build warnings of the form {{WARNING: Tried to skip objects {'SingleFrameFromGenericPlugin', 'ForcedFromGenericPlugin'} in module lsst.meas.base, but they were not present. Ignoring}}. These are due to DM-15461 . They're fundamentally harmless, and addressing them would involve either significant work on the Sphinx infrastructure or significant rewriting of the meas_base code. Again, I propose to rule them out of scope for this ticket. When building standalone, there are six warnings generated by :lsst-task: references to tasks in other packages. This is unavoidable with the current documentation system (other than by simply not including these references). I've filed DM-17014 to address this. While the docstrings for Python modules are generally pretty good, I took only a cursory pass through the tests, tweaking formatting and fixing a few typos. Most of the tests have no meaningful docstrings; fixing that would involve allocation substantial effort, and I doubt this will ever be useful. 50 further warnings are generated when building without the DM-11558 branch of pex_config.
            Hide
            swinbank John Swinbank added a comment -

            Russell Owen — thank you for agreeing to take a look at this! Please see the comment above for a little background.

            PR is here: https://github.com/lsst/meas_base/pull/130

            I've confirmed that this builds and passes tests.

            Show
            swinbank John Swinbank added a comment - Russell Owen — thank you for agreeing to take a look at this! Please see the comment above for a little background. PR is here: https://github.com/lsst/meas_base/pull/130 I've confirmed that this builds and passes tests.
            Hide
            rowen Russell Owen added a comment -

            Overall looks good. A few requests on github.

            Show
            rowen Russell Owen added a comment - Overall looks good. A few requests on github.
            Hide
            swinbank John Swinbank added a comment -

            Thank you for the speedy turnaround!

            I propose to go ahead and merge this after I've addressed Russell's requests. That'll mean generating a lot of warnings until DM-11558 merges, but I think that's something we can live with. Jonathan Sick, Russell Owen – please let me know if you're not happy with that.

            Show
            swinbank John Swinbank added a comment - Thank you for the speedy turnaround! I propose to go ahead and merge this after I've addressed Russell's requests. That'll mean generating a lot of warnings until DM-11558 merges, but I think that's something we can live with. Jonathan Sick , Russell Owen – please let me know if you're not happy with that.
            Hide
            swinbank John Swinbank added a comment -

            Merged & done.

            Show
            swinbank John Swinbank added a comment - Merged & done.

              People

              • Assignee:
                swinbank John Swinbank
                Reporter:
                dstaker David Staker [X] (Inactive)
                Reviewers:
                Russell Owen
                Watchers:
                David Staker [X] (Inactive), John Swinbank, Jonathan Sick, Russell Owen
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel