Skip to content

Commit 364ee21

Browse files
committed
docs(run): Fix inline literal markers
why: docutils warned about unmatched interpreted text delimiters in run() docstring. what: - wrap command error and callback examples in double backticks - simplify future change note to avoid backtick imbalance
1 parent cb3517d commit 364ee21

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

src/libvcs/_internal/run.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,12 +157,12 @@ def run(
157157
subprocess in real time instead of when the process finishes.
158158
159159
check_returncode : bool
160-
Indicate whether a `libvcs.exc.CommandError` should be raised if return code is
160+
Indicate whether a ``libvcs.exc.CommandError`` should be raised if return code is
161161
different from 0.
162162
163163
callback : ProgressCallbackProtocol
164164
callback to return output as a command executes, accepts a function signature
165-
of `(output, timestamp)`. Example usage::
165+
of ``(output, timestamp)``. Example usage::
166166
167167
def progress_cb(output, timestamp):
168168
sys.stdout.write(output)
@@ -171,7 +171,7 @@ def progress_cb(output, timestamp):
171171
172172
Upcoming changes
173173
----------------
174-
When minimum python >= 3.10, `pipesize: int = -1` will be added after `umask`.
174+
When minimum python >= 3.10, pipesize: int = -1 will be added after umask.
175175
"""
176176
proc = subprocess.Popen(
177177
args,

0 commit comments

Comments
 (0)