Python: Formatted docstrings to numpydoc (Take, Give -> Parameters, Returns) #2467
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
longjon
added a commit
that referenced
this pull request
May 15, 2015
Python: Formatted docstrings to numpydoc (Take, Give -> Parameters, Returns)
|
Nice, thank you @MartinThoma! We should look into putting these on the web at some point... |
|
@longjon It would be much easier to put them on the web (e.g. pythonhosted.org or readthedocs.org; both are well-known free (without advertising) hosting services for Python package documentation) if the Python part was a package. However, I am not sure how this package should deal with the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Again a very simple, documentation-only pull request.
(I did not see those the first time. Now I
greped through the Python code to make sure the I got all "Give" and "Take")