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

Rewrite docstrings to match scikit-learn Style #491

Open
desilinguist opened this issue Nov 25, 2020 — with Slack · 1 comment
Open

Rewrite docstrings to match scikit-learn Style #491

desilinguist opened this issue Nov 25, 2020 — with Slack · 1 comment
Labels
documentation enhancement help wanted

Comments

@desilinguist Slack
Copy link
Member

We should try and match the way that scikit-learn writes their docstrings. Here is an example.

For example, there is a blank line between the parameters and the default values are indicated right after the parameter type. It's also nice how the types that are numpy arrays also include the shapes.
@desilinguist desilinguist added the enhancement label Nov 25, 2020 — with Slack
@desilinguist
Copy link
Member Author

desilinguist commented Nov 25, 2020 •
edited
Loading

See also this issue for SKLL.

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

No branches or pull requests
1 participant
@desilinguist