DOC Add note on backtick rendering #24368
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
ogrisel
reviewed
Sep 6, 2022
doc/developers/contributing.rst
Outdated
| @@ -846,6 +846,10 @@ Finally, follow the formatting rules below to make it consistently good: | |||
| * When editing reStructuredText (``.rst``) files, try to keep line length under | |||
| 80 characters when possible (exceptions include links and tables). | |||
|
|
|||
| * Both single and double backticks surrounding text will render as inline | |||
| literal ('code', e.g., `list`), due to specific configurations set in | |||
| scikit-learn. | |||
There was a problem hiding this comment.
Shall we recommend using single quotes by default as a result?
There was a problem hiding this comment.
I think you mean single backtick?
glemaitre
reviewed
Sep 7, 2022
glemaitre
reviewed
Sep 7, 2022
doc/developers/contributing.rst
Outdated
| @@ -846,6 +846,10 @@ Finally, follow the formatting rules below to make it consistently good: | |||
| * When editing reStructuredText (``.rst``) files, try to keep line length under | |||
| 80 characters when possible (exceptions include links and tables). | |||
|
|
|||
| * In scikit-learn reStructuredText files both single and double backticks | |||
| surrounding text will render as inline literal (often used for code, e.g., | |||
| `list`). This is due to specific configurations we have set. | |||
There was a problem hiding this comment.
Suggested change
| `list`). This is due to specific configurations we have set. | |
| `list`). This is due to specific configurations we have set. Single | |
| backticks should be used nowadays. |
|
Thanks! Amended! |
|
Thanks @lucyleeow |
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.
Reference Issues/PRs
Relates to #14817 (comment)
What does this implement/fix? Explain your changes.
Add note on backtick rendering
Any other comments?
Happy to change wording. Was not sure if I should recommend use of one form over the other?
cc @thomasjpfan