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

Fix python warnings on /param in doxygen docstrings

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Invalid
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: 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

            No work has yet been logged on this issue.

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              Parejkoj John Parejko
              Watchers:
              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.