From 7f842c2b84b53d5949501e10f4dafe675ddcac2f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mart=C3=AD=20Bol=C3=ADvar?= Date: Mon, 9 Oct 2023 10:42:48 -0700 Subject: [PATCH] commands: fix some docstrings MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit When interpreted as restructured text, these are causing errors because the '**' is interpreted as the start of a bold section, which never ends. This causes build failures in the zephyr docs, which do treat these as RST. Wrap them in `` to make the whole thing a literal block to fix this issue. Signed-off-by: Martí Bolívar --- src/west/commands.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/west/commands.py b/src/west/commands.py index 5e1304e..8ffb7df 100644 --- a/src/west/commands.py +++ b/src/west/commands.py @@ -303,21 +303,21 @@ class WestCommand(ABC): # def check_call(self, args, **kwargs): - '''Runs subprocess.check_call(args, **kwargs) after + '''Runs ``subprocess.check_call(args, **kwargs)`` after logging the call at Verbosity.DBG_MORE level.''' self._log_subproc(args, **kwargs) subprocess.check_call(args, **kwargs) def check_output(self, args, **kwargs): - '''Runs subprocess.check_output(args, **kwargs) after + '''Runs ``subprocess.check_output(args, **kwargs)`` after logging the call at Verbosity.DBG_MORE level.''' self._log_subproc(args, **kwargs) return subprocess.check_output(args, **kwargs) def run_subprocess(self, args, **kwargs): - '''Runs subprocess.run(args, **kwargs) after logging + '''Runs ``subprocess.run(args, **kwargs)`` after logging the call at Verbosity.DBG_MORE level.''' self._log_subproc(args, **kwargs)