Skip to content

Commit

Permalink
commands: fix some docstrings
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
mbolivar-ampere committed Oct 9, 2023
1 parent 7d108ff commit 7f842c2
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/west/commands.py
Original file line number Diff line number Diff line change
Expand Up @@ -303,21 +303,21 @@ def _log_subproc(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.'''

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)
Expand Down

0 comments on commit 7f842c2

Please sign in to comment.