diff options
| author | David Lord <davidism@gmail.com> | 2020-08-14 10:07:20 -0700 |
|---|---|---|
| committer | David Lord <davidism@gmail.com> | 2020-08-14 10:07:20 -0700 |
| commit | 183a7f83836fae90affc28d6eb2676014b3077e9 (patch) | |
| tree | a07315a114511404302e7589b9ca026b855726ae /src/click/termui.py | |
| parent | a141a2a1e646434c1d88d45003a1edd2e49d8b41 (diff) | |
| download | click-183a7f83836fae90affc28d6eb2676014b3077e9.tar.gz | |
document that launch(wait) only works for blocking programs
Diffstat (limited to 'src/click/termui.py')
| -rw-r--r-- | src/click/termui.py | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/src/click/termui.py b/src/click/termui.py index 44e0b80..1eb9ed8 100644 --- a/src/click/termui.py +++ b/src/click/termui.py @@ -658,7 +658,9 @@ def launch(url, wait=False, locate=False): .. versionadded:: 2.0 :param url: URL or filename of the thing to launch. - :param wait: waits for the program to stop. + :param wait: Wait for the program to exit before returning. This + only works if the launched program blocks. In particular, + ``xdg-open`` on Linux does not block. :param locate: if this is set to `True` then instead of launching the application associated with the URL it will attempt to launch a file manager with the file located. This |