Skip to content

Commit d9fb4a9

Browse files
committed
Issue python#29371: Clarify bitwise OR operation in doctest option flags.
1 parent ed45f73 commit d9fb4a9

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

Doc/library/doctest.rst

+7-6
Original file line numberDiff line numberDiff line change
@@ -530,8 +530,8 @@ Option Flags
530530

531531
A number of option flags control various aspects of doctest's behavior.
532532
Symbolic names for the flags are supplied as module constants, which can be
533-
or'ed together and passed to various functions. The names can also be used in
534-
:ref:`doctest directives <doctest-directives>`.
533+
:ref:`bitwise ORed <bitwise>` together and passed to various functions.
534+
The names can also be used in :ref:`doctest directives <doctest-directives>`.
535535

536536
The first group of options define test semantics, controlling aspects of how
537537
doctest decides whether actual output matches an example's expected output:
@@ -1161,10 +1161,11 @@ reporting flags specific to :mod:`unittest` support, via this function:
11611161
the option flags specified for the test case when the :class:`DocTestCase`
11621162
instance was constructed. If no reporting flags were specified (which is the
11631163
typical and expected case), :mod:`doctest`'s :mod:`unittest` reporting flags are
1164-
or'ed into the option flags, and the option flags so augmented are passed to the
1165-
:class:`DocTestRunner` instance created to run the doctest. If any reporting
1166-
flags were specified when the :class:`DocTestCase` instance was constructed,
1167-
:mod:`doctest`'s :mod:`unittest` reporting flags are ignored.
1164+
:ref:`bitwise ORed <bitwise>` into the option flags, and the option flags
1165+
so augmented are passed to the :class:`DocTestRunner` instance created to
1166+
run the doctest. If any reporting flags were specified when the
1167+
:class:`DocTestCase` instance was constructed, :mod:`doctest`'s
1168+
:mod:`unittest` reporting flags are ignored.
11681169

11691170
The value of the :mod:`unittest` reporting flags in effect before the function
11701171
was called is returned by the function.

0 commit comments

Comments
 (0)