Skip to content

Commit 7f9e43a

Browse files
committed
docs(shortcuts,util): Fix autodoc formatting
1 parent 128dc1e commit 7f9e43a

File tree

2 files changed

+15
-16
lines changed

2 files changed

+15
-16
lines changed

libvcs/shortcuts.py

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,16 @@ def create_repo(url, vcs, **kwargs):
2525
... )
2626
2727
>>> r.update_repo()
28-
29-
|myrepo| (git) Repo directory for myrepo (git) does not exist @ \
30-
/tmp/myrepo
31-
|myrepo| (git) Cloning.
32-
|myrepo| (git) git clone https://www.github.com/tony/myrepo \
33-
/tmp/myrepo
34-
Cloning into '/tmp/myrepo'...
35-
Checking connectivity... done.
36-
|myrepo| (git) git fetch
37-
|myrepo| (git) git pull
38-
Already up-to-date.
28+
|myrepo| (git) Repo directory for myrepo (git) does not exist @ \
29+
/tmp/myrepo
30+
|myrepo| (git) Cloning.
31+
|myrepo| (git) git clone https://www.github.com/tony/myrepo \
32+
/tmp/myrepo
33+
Cloning into '/tmp/myrepo'...
34+
Checking connectivity... done.
35+
|myrepo| (git) git fetch
36+
|myrepo| (git) git pull
37+
Already up-to-date.
3938
"""
4039
if vcs == 'git':
4140
return GitRepo(url, **kwargs)

libvcs/util.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -151,12 +151,12 @@ def run(
151151
152152
callback : callable
153153
callback to return output as a command executes, accepts a function signature
154-
of `(output, timestamp)`. Example usage:
154+
of `(output, timestamp)`. Example usage::
155155
156-
def progress_cb(output, timestamp):
157-
sys.stdout.write(output)
158-
sys.stdout.flush()
159-
run(['git', 'pull'], callback=progrses_cb)
156+
def progress_cb(output, timestamp):
157+
sys.stdout.write(output)
158+
sys.stdout.flush()
159+
run(['git', 'pull'], callback=progrses_cb)
160160
"""
161161
proc = subprocess.Popen(
162162
cmd, shell=shell, stderr=subprocess.PIPE, stdout=subprocess.PIPE, cwd=cwd,

0 commit comments

Comments
 (0)