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.

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

Make docstring formatting consistent #56

Closed
neubig opened this issue Apr 24, 2017 · 3 comments
Closed

Make docstring formatting consistent #56

neubig opened this issue Apr 24, 2017 · 3 comments

Comments

@neubig
Copy link
Contributor

neubig commented Apr 24, 2017

Currently the format of our docstrings is not consistent. I'd suggest following the format in ResidualLSTMEncoder, as it seems to be the most thoroughly documented. We should also add the documentation style to the README.md or some other coding style document.

Update: To be more clear -- This means "use double quotes for docstrings" and "mark parameters as @param"

@neubig
Copy link
Contributor Author

neubig commented Apr 24, 2017

Update again: perhaps we should follow a previous convention. How about either:

Any preference?

@neubig
Copy link
Contributor Author

neubig commented Apr 24, 2017

Sorry about the spam. Here is a good answer on stack overflow: http://stackoverflow.com/questions/3898572/what-is-the-standard-python-docstring-format

The Google and Numpy formats seem too verbose, so perhaps it'd be best to go with reST format used in Devendra's files. I'll go ahead with that.

@neubig
Copy link
Contributor Author

neubig commented May 29, 2017

Should be fixed by 4c14422

@neubig neubig closed this as completed May 29, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant