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

Convert afw.math to numpydoc

    XMLWordPrintable

Details

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

    Description

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

      Attachments

        Issue Links

          Activity

            krzys Krzysztof Findeisen added a comment - - edited

            Hi swinbank, would you be willing to review this ticket? The conversions are about 260 lines of code and 580 lines of page-oriented documentation (the latter is so big mainly because I inlined the example code).

            Edit: PR is afw#428.

            krzys Krzysztof Findeisen added a comment - - edited Hi swinbank , would you be willing to review this ticket? The conversions are about 260 lines of code and 580 lines of page-oriented documentation (the latter is so big mainly because I inlined the example code). Edit: PR is afw#428 .

            Looks good — thank you for doing this.

            I made a few comments on the PR, but I don't think there's anything particularly awkward.

            swinbank John Swinbank added a comment - Looks good — thank you for doing this. I made a few comments on the PR, but I don't think there's anything particularly awkward.

            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.