DOC: Fix broken formatting on docstring examples with first-line comments #9803
Conversation
This file contains hidden or 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
|
Thanks for noticing! But, the 'correct' solution is that there should be a blank line between the explanation and the code. In this way the Also the see https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt#sections for a reference |
|
But very welcome to update the PR! |
|
Yes, forgot about this. |
evanpw
force-pushed
the
interpolate_example
branch
from
1eb75d6 to
856bf21
Compare
|
Squashed |
|
Thanks! |
jorisvandenbossche
added a commit
that referenced
this pull request
Apr 28, 2015
DOC: Fix broken formatting on docstring examples with first-line comments
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.
Examples for
interpolateandgroupbyweren't being formatted correctly. See http://pandas.pydata.org/pandas-docs/version/0.16.0/generated/pandas.Series.interpolate.html and http://pandas.pydata.org/pandas-docs/version/0.16.0/generated/pandas.Series.groupby.html