OrgZephyr/west
OrgZephyr
/
west
mirror of https://github.com/zephyrproject-rtos/west.git
1
0
Fork 0
Code Issues Releases Wiki Activity

commands: fix some docstrings 

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 <mbolivar@amperecomputing.com>
This commit is contained in:
Martí Bolívar 2023-10-09 10:42:48 -07:00 committed by Martí Bolívar
parent 7d108ff1ce
commit 7f842c2b84
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/west/commands.py
View File

@ -303,21 +303,21 @@ class WestCommand(ABC):
# #
def check_call(self, args, **kwargs): 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.''' logging the call at Verbosity.DBG_MORE level.'''
self._log_subproc(args, **kwargs) self._log_subproc(args, **kwargs)
subprocess.check_call(args, **kwargs) subprocess.check_call(args, **kwargs)
def check_output(self, 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.''' logging the call at Verbosity.DBG_MORE level.'''
self._log_subproc(args, **kwargs) self._log_subproc(args, **kwargs)
return subprocess.check_output(args, **kwargs) return subprocess.check_output(args, **kwargs)
def run_subprocess(self, 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.''' the call at Verbosity.DBG_MORE level.'''
self._log_subproc(args, **kwargs) self._log_subproc(args, **kwargs)