Skip to content

Commit db19b2c

Browse files
Carreaumdhaber
andauthored
Apply suggestions from code review
Co-authored-by: Matt Haberland <[email protected]>
1 parent ed89d7f commit db19b2c

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

doc/format.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -753,9 +753,8 @@ monospaced font; in reST, *double* backticks are for ``monospaced font``,
753753
whereas the behavior of single backticks is defined by the default role. This
754754
leads to the following style recommendations:
755755

756-
- Any object that can be linked to should be enclosed in single backticks. That
757-
is to say : Module, class, function, method, and attribute names are some of
758-
the objects that should be enclosed in single backticks. On a case by cases,
756+
- For example, module, class, function, method, and attribute names
757+
should be enclosed in single backticks. On a case-by-case basis,
759758
instances may also be included in single backticks, like :py:obj:`None`,
760759
:py:obj:`True`, :py:obj:`False`.
761760

0 commit comments

Comments
 (0)