Skip to content

DOC Add note on backtick rendering #24368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 8, 2022
Merged

DOC Add note on backtick rendering #24368

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
00062c5
add note on backtick
lucyleeow Sep 6, 2022
c287dd7
wording
lucyleeow Sep 6, 2022
b6c9383
wording
lucyleeow Sep 6, 2022
6ae1409
rec single backtick
lucyleeow Sep 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions doc/developers/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -846,6 +846,11 @@ 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. Single
backticks should be used nowadays.

* Before submitting your pull request check if your modifications have
introduced new sphinx warnings and try to fix them.

Expand Down