Fix joinstyles example #13911
Merged
Fix joinstyles example #13911
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
|
Should that be reported as a bug on s-g's side? Even if we put in this fix for now, making the Join styles part a commented section rather than part of the toplevel docstring is more symmetric... |
NelleV
approved these changes
Apr 10, 2019
|
Feel free to open a ticket on SG. In the meantime, this fixes a problem, so I'm going to go ahead and merge. Thanks @timhoffm |
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 a formatting issue with the heading. Original rendered docs:
Cause:
Having a file-level """-docstring immediately followed by a sphinx-gallery comment section is problematic. Each part is stripped when generating the .rst file. In the present case, this results in no blank line before the heading (https://matplotlib.org/devdocs/_sources/gallery/lines_bars_and_markers/joinstyle.rst.txt), which is invalid ReST markup.
Note: Also changed the heading marker to not conflict with triple-quotes.