From 944c46dcb5d0af28952f901a04f3f4384395868e Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Fri, 22 Sep 2023 15:46:38 -0600 Subject: scons_subproc doc: remove :keyword: roles [skip appveyor] Sphinx objects when using :keyword: for a collection of our "unnamed keyword args", where we search through kwargs for them, rather than naming them explicitly in the function signature. These were added in a very recent change. Signed-off-by: Mats Wichmann --- SCons/Action.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/SCons/Action.py b/SCons/Action.py index d761607..e85e5e1 100644 --- a/SCons/Action.py +++ b/SCons/Action.py @@ -837,12 +837,12 @@ def scons_subproc_run( back. Typical case: run a tool's "version" option to find out which version you have installed. - If supplied, the :keyword:`env` keyword argument passes an + If supplied, the ``env`` keyword argument passes an execution environment to process into appropriate form before it is supplied to :mod:`subprocess`; if omitted, *scons_env* is used to derive a suitable default. The other keyword arguments are passed through, - except that SCons legacy :keyword:`error` keyword is remapped to - the subprocess :keyword:`check` keyword. The caller is responsible for + except that SCons legacy ``error` keyword is remapped to + the subprocess ``check` keyword. The caller is responsible for setting up the desired arguments for :func:`subprocess.run`. This function retains the legacy behavior of returning something @@ -858,12 +858,12 @@ def scons_subproc_run( the subprocess; the default ``None`` does no redirection (i.e. output or errors may go to the console or log file, but is not captured); if set to :const:`subprocess.DEVNULL` - they are explicitly thrown away. :keyword:`capture_output` is a - synonym for setting both :keyword:`stdout` and :keyword:`stderr` + they are explicitly thrown away. ``capture_output`` is a + synonym for setting both ``stdout`` and ``stderr`` to :const:`~subprocess.PIPE`. text: open *stdin*, *stdout*, *stderr* in text mode. Default - is binary mode. :keyword:`universal_newlines` is a synonym - - note :keyword:`text` is not understood before Python 3.7. + is binary mode. ``universal_newlines`` is a synonym - + note ``text`` is not understood before Python 3.7. encoding: specifies an encoding. Changes to text mode. errors: specified error handling. Changes to text mode. input: a byte sequence to be passed to *stdin*, unless text -- cgit v0.12