ChatExchange icon indicating copy to clipboard operation
ChatExchange copied to clipboard

Incorrect epydoc tags in docstrings

Open tripleee opened this issue 6 years ago • 2 comments

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)

tripleee avatar Apr 15 '19 06:04 tripleee

I took a closer look at this and it seems there is really very little epydoc documentation here. Is it worth trying to bring it up to date?

tripleee avatar Oct 25 '21 18:10 tripleee

No strong opinion really.

Manishearth avatar Oct 25 '21 19:10 Manishearth