From 25b56e9c6965da3cb900e03f92ca2ff7ff90fd0b Mon Sep 17 00:00:00 2001 From: Debi Mishra Date: Mon, 20 Jul 2020 00:59:19 +0530 Subject: [PATCH] docs: Add a note about -q option used in getting started guide --- AUTHORS | 1 + changelog/7441.doc.rst | 1 + doc/en/getting-started.rst | 4 ++++ 3 files changed, 6 insertions(+) create mode 100644 changelog/7441.doc.rst diff --git a/AUTHORS b/AUTHORS index 040214e33..b28e56133 100644 --- a/AUTHORS +++ b/AUTHORS @@ -81,6 +81,7 @@ David Paul Röthlisberger David Szotten David Vierra Daw-Ran Liou +Debi Mishra Denis Kirisov Dhiren Serai Diego Russo diff --git a/changelog/7441.doc.rst b/changelog/7441.doc.rst new file mode 100644 index 000000000..d7c770e99 --- /dev/null +++ b/changelog/7441.doc.rst @@ -0,0 +1 @@ +Add a note about ``-q`` option used in getting started guide. diff --git a/doc/en/getting-started.rst b/doc/en/getting-started.rst index 0424faa88..38adf68e0 100644 --- a/doc/en/getting-started.rst +++ b/doc/en/getting-started.rst @@ -112,6 +112,10 @@ Execute the test function with “quiet” reporting mode: . [100%] 1 passed in 0.12s +.. note:: + + The ``-q/--quiet`` flag keeps the output brief in this and following examples. + Group multiple tests in a class --------------------------------------------------------------