Skip to content

Commit

Permalink
Document that silent=True returns the command output (#578)
Browse files Browse the repository at this point in the history
* Document that `silent=True` returns the command output

* Update the `silent=True` doc

Modify the wording.

Co-authored-by: Tom Fleet <tomfleet2018@gmail.com>

Co-authored-by: Tom Fleet <tomfleet2018@gmail.com>
  • Loading branch information
DiddiLeija and FollowTheProcess committed Feb 15, 2022
1 parent 466c576 commit 4c2fc29
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions nox/sessions.py
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,7 @@ def run(
command. By default, all environment variables are passed.
:type env: dict or None
:param bool silent: Silence command output, unless the command fails.
If ``True``, returns the command output (unless the command fails).
``False`` by default.
:param success_codes: A list of return codes that are considered
successful. By default, only ``0`` is considered success.
Expand Down

0 comments on commit 4c2fc29

Please sign in to comment.