# Fix python warnings on /param in doxygen docstrings

XMLWordPrintable

#### Details

• Type: Story
• Status: Invalid
• Resolution: Done
• Fix Version/s: None
• Component/s: None
• Labels:

#### 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.

#### Activity

Hide
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
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

Assignee:
Unassigned
Reporter:
John Parejko
Watchers:
John Parejko, Kian-Tat Lim, Russell Owen, Tim Jenness