Document formatting strings in the docs #15379
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
79c1c56 to
476a03e
Compare
dstansby
reviewed
Oct 6, 2019
| @@ -410,6 +410,12 @@ Use simple single or double quotes when giving string values, e.g. | |||
|
|
|||
| If 'tight', try to figure out the tight bbox of the figure. | |||
|
|
|||
| No ``'extra'`` literal quotes. | |||
There was a problem hiding this comment.
Was this meant to be a title instead of part of the code block?
There was a problem hiding this comment.
No, this is intentional. Originally, I tried to put this in an inline lieteral:
The use of extra literal quotes around the text (````'extra'````) is discouraged.
However, it appears that four backticks followed by a single-quote or double-quote character are not interpreted correctly by Sphinx/ReST (in contrast followed by a letter works, e.g. ````literal```` further above).
I would like to have the negative example shown somewhere, but did not manage to write it as an inline literal. So I just added it it to the block literal.
476a03e to
8c7d0e9
Compare
tacaswell
approved these changes
Oct 7, 2019
|
Although this is a doc change, I don't think we need to pull it back to the 3.1 branches. |
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Oct 7, 2019
dstansby
added a commit
that referenced
this pull request
Oct 7, 2019
…379-on-v3.2.x Backport PR #15379 on branch v3.2.x (Document formatting strings in the docs)
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
Clarification motivated by #15375 (comment).
Based on #10225 (section
String values).Plus a minor wording fix in one of the examples.