close
The Wayback Machine - https://web.archive.org/web/20200628093423/https://github.com/modin-project/modin/issues/1411
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

Convert docstrings to numpydoc #1411

Open
anmyachev opened this issue Apr 29, 2020 · 3 comments
Open

Convert docstrings to numpydoc #1411

anmyachev opened this issue Apr 29, 2020 · 3 comments

Comments

@anmyachev
Copy link
Contributor

@anmyachev anmyachev commented Apr 29, 2020

Is your feature request related to a problem? Please describe.
Since in the near future a large number of new people will begin to work on the project, it is necessary to agree on a standard for docstrings. And introduce some kind of automatic checks.

For my part, I would like to suggest nympydoc package that we can use in github actions CI.

@devin-petersohn
Copy link
Member

@devin-petersohn devin-petersohn commented Apr 30, 2020

So far, the approach has been:

def some_method(self, arg1, arg2):
	"""The one-line description of the method.

	Args:
		arg1: Description
		arg2: Description

	Returns:
		What this returns (if anything)
	"""
	# Begin implementation
	return something

I am open to new suggestions as long as we are standardized. numpydoc seems reasonable, interested to hear other opinions.

@aregm
Copy link
Contributor

@aregm aregm commented Apr 30, 2020

Looks like numpydoc has a standard extension in sphinx, which will make the cross-reference easier.

@devin-petersohn
Copy link
Member

@devin-petersohn devin-petersohn commented May 9, 2020

numpydoc is a good testable standard. Let's go with that. We can install pydocstyle and test from bash with

pydocstyle --convention=numpy modin/pandas
@devin-petersohn devin-petersohn changed the title python docstring standard and auto checks Convert docstrings to numpydoc May 9, 2020
@devin-petersohn devin-petersohn added this to the 0.7.4 milestone May 9, 2020
@anmyachev anmyachev mentioned this issue May 28, 2020
5 of 5 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.