You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Jan 1, 2020. It is now read-only.
It would be more clear how this package fits into the python science ecosystem if the docstrings followed the numpydoc format (here is its explanation). This basically entails writing parameters etc with the following form:
defmy_function(a, b=None):
"""Do my function. This function does blah blah. Parameters ----------- a : int | float Explanation of a. b : string | None Explanation of b. Returns -------- something : instance of XXX Explanation of something """andsoon...
I think this would make the documentation more readable, and it'd make it possible to build API docs on the web quite easily. What are thoughts on using this?
The text was updated successfully, but these errors were encountered:
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.
It would be more clear how this package fits into the python science ecosystem if the docstrings followed the
numpydoc
format (here is its explanation). This basically entails writing parameters etc with the following form:I think this would make the documentation more readable, and it'd make it possible to build API docs on the web quite easily. What are thoughts on using this?
The text was updated successfully, but these errors were encountered: