Fix a format error in documenting_mpl.rst #13010
Merged
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
anntzer
previously approved these changes
Dec 17, 2018
8a7cc4e to
972ffaf
Compare
Sorry, generalized the PR as we can now do much better formatting. Therefore dismissing your review.
|
fwiw adding the indents makes the things look quite ugly on pydoc or ipython's ??, because they show up as spaces in the middle of the line. |
|
You're right with pydoc:
ipython looks ok:
Pydoc seems to interpret the line continuation, ipython does not. And now, which do we favor? ipython gets better pydoc gets worse. |
|
ipython looks worse with ? (? behaves like pydoc whereas ?? just gives the raw source) |
|
Ok, got it. Reverted and added a note so that nobody will try that again 😄 . @anntzer Thanks for watching out. Could you please re-approve? |
972ffaf to
3ae94c6
Compare
anntzer
approved these changes
Dec 17, 2018
dstansby
approved these changes
Dec 18, 2018
6 tasks
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.
PR Summary
Fixes an unintended line break, which made the example non-compliant with numpydoc.
I was sure last time I tried, the continued line would not allow any indent. However, no it works with indents. Not sure if this is due to some version updates.Anyway, changing all occurences as this gives much nicer plain-text docstrings.