Skip to content

Issue 11354 fixing docs for lfnf #11361

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

Merged
nicoddemus merged 9 commits into from
Aug 29, 2023
Merged

Issue 11354 fixing docs for lfnf #11361

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
b98d293
docs: changing some docs for last-failed-no-failures
seanjedi Aug 26, 2023
66e7a1f
docs: improve --lfnf docs to make functionality more clear
seanjedi Aug 27, 2023
3be5d3e
Merge branch 'pytest-dev:main' into issue_11354-Fixing-docs-for-lfnf
seanjedi Aug 27, 2023
722b487
Merge branch 'pytest-dev:main' into issue_11354-Fixing-docs-for-lfnf
seanjedi Aug 28, 2023
75e815f
docs: updating the docs to make --lfnf more clear
seanjedi Aug 28, 2023
e431b8e
docs: Add a bit more to the doc for --lfnf
seanjedi Aug 28, 2023
e121c50
docs: quick change
seanjedi Aug 28, 2023
5ac0a7a
Update src/_pytest/cacheprovider.py
nicoddemus Aug 28, 2023
02f84bc
docs: Added the name of the option we are changing the docs for
seanjedi Aug 28, 2023
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
Prev Previous commit
Next Next commit
docs: improve --lfnf docs to make functionality more clear
  • Loading branch information
@seanjedi
seanjedi committed Aug 27, 2023
commit 66e7a1f6bfcf43e2bc0f724fbfed924af16c5d80
3 changes: 3 additions & 0 deletions doc/en/how-to/cache.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,9 @@ using the ``--last-failed-no-failures`` option, which takes one of the following
pytest --last-failed --last-failed-no-failures all # run all tests (default behavior)
pytest --last-failed --last-failed-no-failures none # run no tests and exit

The ``--last-failed-no-failures`` option governs the behavior of ``--if``.
Default ``all`` runs all tests with no known failures. ``none`` avoids tests and exits successfully when there are no known failures.
Copy link
Member

@nicoddemus nicoddemus Aug 28, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO this does not add much to what we already have above (and people found lacking in the first place).

Feel free to not only add to this section, but rewrite it entirely if you think it would be better.

Copy link
Contributor Author

@seanjedi seanjedi Aug 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

update the docs here: 75e815f


The new config.cache object
--------------------------------

Expand Down
5 changes: 4 additions & 1 deletion doc/en/reference/reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1894,7 +1894,10 @@ All the command-line flags can be obtained by running ``pytest --help``::
--lfnf={all,none}, --last-failed-no-failures={all,none}
Determines whether to execute tests when there
are no previously (known) failures or when no
cached ``lastfailed`` data was found
cached ``lastfailed`` data was found.
This option governs the behavior of ``--if``.
Default ``all`` runs all tests with no known failures.
``none`` avoids tests and exits if no failures.
--sw, --stepwise Exit on test failure and continue from last failing
test next time
--sw-skip, --stepwise-skip
Expand Down
5 changes: 4 additions & 1 deletion src/_pytest/cacheprovider.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -500,7 +500,10 @@ def pytest_addoption(parser: Parser) -> None:
choices=("all", "none"),
default="all",
help="Determines whether to execute tests when there are no previously (known)"
Copy link
Member

@nicoddemus nicoddemus Aug 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update this with the above suggestion.

Copy link
Contributor Author

@seanjedi seanjedi Aug 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

update the docs here: 75e815f

"failures or when no cached ``lastfailed`` data was found",
"failures or when no cached ``lastfailed`` data was found."
"This option governs the behavior of ``--if``."
"Default ``all`` runs all tests with no known failures."
"``none`` avoids tests and exits if no failures.",
)


Expand Down