Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify docs on --gherkin-terminal-reporter #697

Merged
merged 3 commits into from
Sep 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ These people have contributed to `pytest-bdd`, in alphabetical order:
* `Floris Bruynooghe <[email protected]>`_
* `Harro van der Klauw <[email protected]>`_
* `Hugo van Kemenade <https://github.com/hugovk>`_
* `Kyle Adams <https://github.com/kadams54>`_
* `Laurence Rowe <[email protected]>`_
* `Leonardo Santagada <[email protected]>`_
* `Milosz Sliwinski <sliwinski-milosz>`_
Expand Down
1 change: 1 addition & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ Changelog

Unreleased
----------
- Update documentation to clarify that `--gherkin-terminal-reporter` needs to be used with `-v` or `-vv`.
- Drop compatibility with pytest < 7.0.0.

8.0.0b1
Expand Down
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1054,11 +1054,11 @@ To have an output in json format:

This will output an expanded (meaning scenario outlines will be expanded to several scenarios) Cucumber format.

To enable gherkin-formatted output on terminal, use
To enable gherkin-formatted output on terminal, use `--gherkin-terminal-reporter` in conjunction with the `-v` or `-vv` options:

::

pytest --gherkin-terminal-reporter
pytest -v --gherkin-terminal-reporter


Test code generation helpers
Expand Down
Loading