Skip to content

Commit 0a3801e

Browse files
authored
Merge pull request #4422 from mwichmann/doc/scons_subproc
scons_subproc doc: remove keyword roles
2 parents a932578 + 944c46d commit 0a3801e

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

SCons/Action.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -837,12 +837,12 @@ def scons_subproc_run(
837837
back. Typical case: run a tool's "version" option to find out which
838838
version you have installed.
839839
840-
If supplied, the :keyword:`env` keyword argument passes an
840+
If supplied, the ``env`` keyword argument passes an
841841
execution environment to process into appropriate form before it is
842842
supplied to :mod:`subprocess`; if omitted, *scons_env* is used to derive
843843
a suitable default. The other keyword arguments are passed through,
844-
except that SCons legacy :keyword:`error` keyword is remapped to
845-
the subprocess :keyword:`check` keyword. The caller is responsible for
844+
except that SCons legacy ``error` keyword is remapped to
845+
the subprocess ``check` keyword. The caller is responsible for
846846
setting up the desired arguments for :func:`subprocess.run`.
847847
848848
This function retains the legacy behavior of returning something
@@ -858,12 +858,12 @@ def scons_subproc_run(
858858
the subprocess; the default ``None`` does no redirection
859859
(i.e. output or errors may go to the console or log file,
860860
but is not captured); if set to :const:`subprocess.DEVNULL`
861-
they are explicitly thrown away. :keyword:`capture_output` is a
862-
synonym for setting both :keyword:`stdout` and :keyword:`stderr`
861+
they are explicitly thrown away. ``capture_output`` is a
862+
synonym for setting both ``stdout`` and ``stderr``
863863
to :const:`~subprocess.PIPE`.
864864
text: open *stdin*, *stdout*, *stderr* in text mode. Default
865-
is binary mode. :keyword:`universal_newlines` is a synonym -
866-
note :keyword:`text` is not understood before Python 3.7.
865+
is binary mode. ``universal_newlines`` is a synonym -
866+
note ``text`` is not understood before Python 3.7.
867867
encoding: specifies an encoding. Changes to text mode.
868868
errors: specified error handling. Changes to text mode.
869869
input: a byte sequence to be passed to *stdin*, unless text

0 commit comments

Comments
 (0)