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

          mentioned in

          Page Loading...

          Page Loading...

            Activity

            Ascending order - Click to sort in descending order
            No builds found.
            Parejkoj John Parejko created issue -
            jbosch Jim Bosch made changes -
            Field Original Value New Value
            Remote Link This issue links to "Page (Confluence)" [ 16700 ]
            tjenness Tim Jenness made changes -
            Remote Link This issue links to "Page (Confluence)" [ 31132 ]
            Hide
            Permalink
            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.

            Show
            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 made changes -
            Resolution Done [ 10000 ]
            Status To Do [ 10001 ] Invalid [ 11005 ]

              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.