Fix RST backticks #1554
Merged
Fix RST backticks #1554
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
hugovk
commented
Aug 6, 2020
pep-0613.rst
Outdated
| @@ -88,7 +88,7 @@ across the codebase. | |||
|
|
|||
| With explicit aliases, the type checker has enough information to error on the | |||
| actual definition of the bad type alias, and explain why: that :code:`MyGeneric(int)` | |||
| and `InvalidType` are not valid types. When the value expression is no longer | |||
| and code:`InvalidType` are not valid types. When the value expression is no longer | |||
There was a problem hiding this comment.
The code: prefix is used here for consistency because the rest of this file uses it.
There was a problem hiding this comment.
I guess you'd like to use :code: role here, right?
There was a problem hiding this comment.
I believe @tk0miya is suggesting:
Suggested change
| and code:`InvalidType` are not valid types. When the value expression is no longer | |
| and :code:`InvalidType` are not valid types. When the value expression is no longer |
But we are not using docutils, so it probably should be:
Suggested change
| and code:`InvalidType` are not valid types. When the value expression is no longer | |
| and ``InvalidType`` are not valid types. When the value expression is no longer |
There was a problem hiding this comment.
Yep, I did mean :code:, thanks!
But I'll update all the `:code:X` in this file to ``X``
e0fc443 to
669e030
Compare
669e030 to
76cbfeb
Compare
brettcannon
requested changes
Aug 6, 2020
pep-0613.rst
Outdated
| @@ -88,7 +88,7 @@ across the codebase. | |||
|
|
|||
| With explicit aliases, the type checker has enough information to error on the | |||
| actual definition of the bad type alias, and explain why: that :code:`MyGeneric(int)` | |||
| and `InvalidType` are not valid types. When the value expression is no longer | |||
| and code:`InvalidType` are not valid types. When the value expression is no longer | |||
There was a problem hiding this comment.
I believe @tk0miya is suggesting:
Suggested change
| and code:`InvalidType` are not valid types. When the value expression is no longer | |
| and :code:`InvalidType` are not valid types. When the value expression is no longer |
But we are not using docutils, so it probably should be:
Suggested change
| and code:`InvalidType` are not valid types. When the value expression is no longer | |
| and ``InvalidType`` are not valid types. When the value expression is no longer |
brettcannon
approved these changes
Aug 7, 2020
|
Thanks! |
AA-Turner
pushed a commit
to AA-Turner/peps
that referenced
this pull request
Aug 15, 2020
mnm678
pushed a commit
to mnm678/peps
that referenced
this pull request
Oct 22, 2020
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.
Update:
In Markdown, single backticks are for inline code:
for_example_like_thisIn reStructuredText, single backticks are for "interpreted text" and "domain- or application-dependent" (see table below).
inline_code_and are meant to be hypertext referencesRef:
I'll send another PR to suggest adding linting to the CI (unless you'd prefer it here?).