ChatExchange
ChatExchange copied to clipboard
Incorrect epydoc tags in docstrings
I was looking at updating the doc strings in a couple of places, but I noticed that the existing docstrings do not appear to adhere to the conventions for epydoc: http://epydoc.sourceforge.net/manual-fields.html
In particular, @param
should be used to describe each function parameter (not @ivar
which is for instance variables)