Skip to content

Conversation

@sam4u3
Copy link
Contributor

@sam4u3 sam4u3 commented Oct 21, 2019

No description provided.

@Akuli
Copy link
Owner

Akuli commented Jul 25, 2020

Sorry for not responding in about a year, lol.

I'm trying to figure out what you meant with this:

It is an excellent choice if you want to do detailed documentation, i.e., extensive documentation of all the functions and parameters.

Other docstring styles have a way to document all functions and parameters too. Why is the numpy style better for that?

@sam4u3
Copy link
Contributor Author

sam4u3 commented Jul 25, 2020

Actually numpy style docstring has more (14+) section for providing details documention.
You can check it out here.
https://numpydoc.readthedocs.io/en/latest/format.html

Akuli added a commit that referenced this pull request Jul 25, 2020
Akuli added a commit that referenced this pull request Jul 25, 2020
@Akuli Akuli merged commit ce8fa36 into Akuli:master Jul 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants