From 4895a4b405cfcab271b952d6485ceb5a9dfe86a9 Mon Sep 17 00:00:00 2001 From: Jarrod Millman Date: Mon, 5 Feb 2024 12:02:41 -0800 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Ross Barnowski Co-authored-by: Matt Haberland --- doc/format.rst | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/doc/format.rst b/doc/format.rst index 28daf036..e9048e44 100644 --- a/doc/format.rst +++ b/doc/format.rst @@ -699,9 +699,7 @@ Other points to keep in mind * Equations : as discussed in the :ref:`Notes ` section above, LaTeX formatting should be kept to a minimum. Often it's possible to show equations as Python code or pseudo-code instead, which is much more readable - in a terminal. For inline display of code (other than individual - :ref:`Parameters `, :ref:`class members `, and linked - modules,functions, and classes; see "Links" below), use double backticks, + in a terminal. For inline display of code use double backticks, like ````y = np.sin(x)````. For display with blank lines above and below, use a double colon and indent the code, like:: @@ -747,8 +745,8 @@ output. New paragraphs are marked with a blank line. Use ``*italics*``, ``**bold**`` if needed in any explanations. -Use of backticks in reST is a common point of confusion it is different from -markdown: +Use of backticks in reST is a common point of confusion because it is different +from markdown: - Module, function, and class names should be enclosed within ```single backticks```. These are intended to render as hyperlinks (e.g. `numpy`). If