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

Fix python warnings on /param in doxygen docstrings

    XMLWordPrintable

Details

    • Story
    • Status: Invalid
    • Resolution: Done
    • None
    • None

    Description

      All of our \param doxygen commands result in python warnings like the following (in this case, when running pipe_tasks tests):

      tests/nopytest_test_coadds.py::MatchMemoryTestCase::testLeaks
        source:282: DeprecationWarning: invalid escape sequence \s
        source:328: DeprecationWarning: invalid escape sequence \p
        source:385: DeprecationWarning: invalid escape sequence \p
      

      We can fix this by replacing all of our doxygen \param and related backslash commands with @param, etc.

      Attachments

        Issue Links

          Activity

            tjenness Tim Jenness added a comment -

            I can't find any \param syntax in the pipelines code so I think this is no longer relevant (with the move to numpydoc helping). We still have plenty of @param lying around but they are not a problem for this ticket.

            meas_astrom is the only package with \param in C++ code.

            tjenness Tim Jenness added a comment - I can't find any \param syntax in the pipelines code so I think this is no longer relevant (with the move to numpydoc helping). We still have plenty of @param lying around but they are not a problem for this ticket. meas_astrom is the only package with \param in C++ code.

            People

              Unassigned Unassigned
              Parejkoj John Parejko
              John Parejko, Kian-Tat Lim, Russell Owen, Tim Jenness
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Jenkins

                  No builds found.