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

Improve Numpydoc documentation in Developer Guide

    XMLWordPrintable

    Details

      Description

      Update the Documenting Python APIs page in the DM Developer Guide to clarify and document issues that have come up in real-world application of Numpydoc-based docstrings in the last few months. This ticket encompasses the issues DM-12926 and DM-12936.

        Attachments

          Issue Links

          relates to

          Improvement - An improvement or enhancement to an existing feature or task. DM-12926 Clarify return value documentation for Python

          • To Do

          Improvement - An improvement or enhancement to an existing feature or task. DM-12936 Clarify formatting for parameters

          • To Do

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            Hey Krzysztof Findeisen, would you be interested in looking at this PR on Numpydoc docs to see if they've addressed your commends from DM-12926 and DM-12936? Draft is at https://developer.lsst.io/v/DM-12951/docs/py_docs.html

            Show
            jsick Jonathan Sick added a comment - Hey Krzysztof Findeisen , would you be interested in looking at this PR on Numpydoc docs to see if they've addressed your commends from DM-12926 and DM-12936 ? Draft is at https://developer.lsst.io/v/DM-12951/docs/py_docs.html
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            Kian-Tat Lim, we've finished a technical review of this documentation update. Could you sign off on this change to the Python API documentation style guide?

            Show
            jsick Jonathan Sick added a comment - Kian-Tat Lim , we've finished a technical review of this documentation update. Could you sign off on this change to the Python API documentation style guide?
            Hide
            Permalink
            ktl Kian-Tat Lim added a comment - - edited

            Some minor edits and a couple of questions (for information only); when the edits are made, you have my approval.

            Show
            ktl Kian-Tat Lim added a comment - - edited Some minor edits and a couple of questions (for information only); when the edits are made, you have my approval.
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            Thanks Kian-Tat Lim and Krzysztof Findeisen. We'll follow-up in DM-13121 to update the unicode docstring standard for the Python 3-only only stack.

            Show
            jsick Jonathan Sick added a comment - Thanks Kian-Tat Lim and Krzysztof Findeisen . We'll follow-up in DM-13121 to update the unicode docstring standard for the Python 3-only only stack.

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Reviewers:
              Krzysztof Findeisen
              Watchers:
              Jonathan Sick, Kian-Tat Lim, Krzysztof Findeisen
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.