Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Incorrect epydoc tags in docstrings #156

Open
tripleee opened this issue Apr 15, 2019 · 2 comments
Open

Incorrect epydoc tags in docstrings #156

tripleee opened this issue Apr 15, 2019 · 2 comments

Comments

@tripleee
Copy link
Contributor

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
Copy link
Contributor Author

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?

@Manishearth
Copy link
Owner

No strong opinion really.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Manishearth @tripleee