Skip to content

Resolves 7 Reformatted Doc #13

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Resolves 7 Reformatted Doc #13

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
610102a
Merge pull request #1 from gsnedders/master
May 10, 2020
d5039ba
#7: Update Readme format
May 10, 2020
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
10 changes: 5 additions & 5 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,16 @@ Installation
How to use
----------

**expect file name**
**Expect file name**

* Default name of the xfail-file is ``.pytest.expect``.
* To customize the name of the xfail-file, use pytest parameter ``--xfail-file <File_Name>``.

**Store the test failures to a file.**

Use ``update-xfail`` parameter. The ``.pytest.expect`` file should be created after the test session is finished.
Use ``update-xfail`` parameter. The ``.pytest.expect`` file should be created after the test session is finished.

.. code-block:: console
.. code-block:: console

>> pytest -vv --update-xfail
. . .
Expand All @@ -39,9 +39,9 @@ How to use

**Apply expect file to a test session**

Once, the xfail-file is created, it will be picked by the module to mark the expected failure as XFAIL. With the XFAIL failures only, the test report will turn green.
Once, the xfail-file is created, it will be picked by the module to mark the expected failure as XFAIL. With the XFAIL failures only, the test report will turn green.

.. code-block:: console
.. code-block:: console

>> pytest -vv
. . .
Expand Down