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

Convert afw.formatters to numpydoc

    XMLWordPrintable

Details

    • Improvement
    • Status: Done
    • Resolution: Done
    • None
    • afw
    • 0.1
    • AP S19-1
    • Alert Production

    Description

      Convert all Doxygen-formatted docstrings in afw.formatters to Numpydoc style, and move corresponding topic documentation to doc/.

      Attachments

        Activity

          Hi swinbank, could you please review this (very trivial) ticket?

          krzys Krzysztof Findeisen added a comment - Hi swinbank , could you please review this (very trivial) ticket?

          Looks fine; thank you.

          You might take this opportunity to remove the docstring from __init__.py since it's useless (and you are explicitly disabling its display). And if you're editing that file, why not take the opportunity to upgrade it to the modern license statement, even though it's technically outside the scope of this ticket?

          swinbank John Swinbank added a comment - Looks fine; thank you. You might take this opportunity to remove the docstring from __init__.py since it's useless (and you are explicitly disabling its display). And if you're editing that file, why not take the opportunity to upgrade it to the modern license statement, even though it's technically outside the scope of this ticket?

          Thanks, I hadn't noticed that somebody already took care of afw/COPYRIGHT. I'll add the change.

          krzys Krzysztof Findeisen added a comment - Thanks, I hadn't noticed that somebody already took care of afw/COPYRIGHT . I'll add the change.

          People

            krzys Krzysztof Findeisen
            krzys Krzysztof Findeisen
            John Swinbank
            John Swinbank, Krzysztof Findeisen
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Jenkins

                No builds found.