From 00062c50effa9ed0d6d70aa6cbb58f19ed742a94 Mon Sep 17 00:00:00 2001 From: lucy liu Date: Tue, 6 Sep 2022 15:47:11 +1000 Subject: [PATCH 1/4] add note on backtick --- doc/developers/contributing.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/developers/contributing.rst b/doc/developers/contributing.rst index b993b03d85cb7..fff8c60c08036 100644 --- a/doc/developers/contributing.rst +++ b/doc/developers/contributing.rst @@ -846,6 +846,9 @@ 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'), due to specific configurations set in scikit-learn. + * Before submitting your pull request check if your modifications have introduced new sphinx warnings and try to fix them. From c287dd75b1b71e0a1a69993adbfa1ef3bd58fd7b Mon Sep 17 00:00:00 2001 From: lucy liu Date: Tue, 6 Sep 2022 15:56:18 +1000 Subject: [PATCH 2/4] wording --- doc/developers/contributing.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/developers/contributing.rst b/doc/developers/contributing.rst index fff8c60c08036..d93ebcae90e3e 100644 --- a/doc/developers/contributing.rst +++ b/doc/developers/contributing.rst @@ -847,7 +847,8 @@ Finally, follow the formatting rules below to make it consistently good: 80 characters when possible (exceptions include links and tables). * Both single and double backticks surrounding text will render as inline - literal ('code'), due to specific configurations set in scikit-learn. + literal ('code', e.g., `list`), due to specific configurations set in + scikit-learn. * Before submitting your pull request check if your modifications have introduced new sphinx warnings and try to fix them. From b6c93835630e95eaaf9392f848783b7ae2861747 Mon Sep 17 00:00:00 2001 From: lucy liu Date: Tue, 6 Sep 2022 20:52:21 +1000 Subject: [PATCH 3/4] wording --- doc/developers/contributing.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/developers/contributing.rst b/doc/developers/contributing.rst index d93ebcae90e3e..bb01e8e50bf86 100644 --- a/doc/developers/contributing.rst +++ b/doc/developers/contributing.rst @@ -846,9 +846,9 @@ 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. +* 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. * Before submitting your pull request check if your modifications have introduced new sphinx warnings and try to fix them. From 6ae14099ff5598291470bb391690c12a6e656cec Mon Sep 17 00:00:00 2001 From: lucy liu Date: Thu, 8 Sep 2022 10:02:55 +1000 Subject: [PATCH 4/4] rec single backtick --- doc/developers/contributing.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/developers/contributing.rst b/doc/developers/contributing.rst index bb01e8e50bf86..bacb9f9615506 100644 --- a/doc/developers/contributing.rst +++ b/doc/developers/contributing.rst @@ -848,7 +848,8 @@ Finally, follow the formatting rules below to make it consistently good: * 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. + `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.