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

Create a full example of a Numpydoc'd module

    XMLWordPrintable

    Details

      Description

      Create a full example of a Python module documented in our Numpydoc style and add it to https://developer.lsst.io/docs/py_docs.html

      See http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html#example-numpy for an example of this.

      Also address the example in https://developer.lsst.io/docs/py_docs.html#examples-of-constant-and-class-attribute-docstrings to show that class attributes are documented separately for init parameters. See https://lsstc.slack.com/archives/C2B6DQBAL/p1518125199000564

        Attachments

          Activity

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

          Also include an example of return a lsst.pipe.base.Struct.

          https://lsstc.slack.com/archives/C2JPMCF5X/p1518651798000221

          Show
          jsick Jonathan Sick added a comment - - edited Also include an example of return a lsst.pipe.base.Struct . https://lsstc.slack.com/archives/C2JPMCF5X/p1518651798000221
          Hide
          Permalink
          jsick Jonathan Sick added a comment -

          Draft at https://developer.lsst.io/v/DM-13525/docs/py_docs.html

          Show
          jsick Jonathan Sick added a comment - Draft at https://developer.lsst.io/v/DM-13525/docs/py_docs.html
          Hide
          Permalink
          tjenness Tim Jenness added a comment -

          Looks great. Some minor comments on PR.

          Show
          tjenness Tim Jenness added a comment - Looks great. Some minor comments on PR.
          Hide
          Permalink
          jsick Jonathan Sick added a comment -

          Thanks Tim Jenness. I think I've addressed all the issues.

          Kian-Tat Lim, are you okay with these changes to the numpydoc standards documentation?

          Show
          jsick Jonathan Sick added a comment - Thanks Tim Jenness . I think I've addressed all the issues. Kian-Tat Lim , are you okay with these changes to the numpydoc standards documentation?
          Hide
          Permalink
          ktl Kian-Tat Lim added a comment -

          Some minor issues with the example module in the PR; otherwise, I approve this change to the documentation standard.

          Show
          ktl Kian-Tat Lim added a comment - Some minor issues with the example module in the PR; otherwise, I approve this change to the documentation standard.

            People

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

              Dates

              Created:
              Updated:
              Resolved:

                Jenkins

                No builds found.