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

Standardized docstrings to NumPy-style #373

Closed
jbiggsets opened this issue Oct 18, 2017 · 2 comments
Closed

Standardized docstrings to NumPy-style #373

jbiggsets opened this issue Oct 18, 2017 · 2 comments

Comments

@jbiggsets
Copy link
Collaborator

This may be a low priority, but it would be useful to standardize all of the docstrings in SKLL to numpy style, and to make sure that all inputs and outputs are consistently documented.

There are a number of methods in the SKLLConfigParser class, for example, that do not have docstrings or whose docstrings do not describe the method's arguments and return values. These are all private methods, but it would still be useful for the purpose of code maintenance and PR reviews to document them.

@desilinguist
Copy link
Member

I'd appreciate if someone else could help tackle this issue.

@jbiggsets jbiggsets self-assigned this Nov 10, 2017
@desilinguist
Copy link
Member

Addressed by #397.

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

2 participants