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.

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

Jump to bottom

document that ava assertions don't throw #2624

Closed
ghost opened this issue Dec 14, 2020 · 5 comments
Closed

document that ava assertions don't throw #2624

ghost opened this issue Dec 14, 2020 · 5 comments
Labels
help wanted scope:assertions scope:documentation

Comments

@ghost
Copy link

ghost commented Dec 14, 2020 •
edited by ghost
Loading

I didn't realize until recently that ava assertions don't stop the test when they fail.

I think this could be documented better, and I'm willing to do so if that's useful
@ghost ghost added the needs triage label Dec 14, 2020
@ghost ghost changed the title document that ava assertions don' document that ava assertions don't throw Dec 14, 2020
@novemberborn
Copy link
Member

novemberborn commented Dec 15, 2020 •
edited
Loading

I thought it was referenced, but I can't immediately spot it in the obvious places. This hints at it:

If multiple assertion failures are encountered within a single test, AVA will only display the first one.

(From https://github.com/avajs/ava/blob/master/docs/03-assertions.md).

That might be the best spot to add a clarification?

@ghost
Copy link
Author

ghost commented Dec 15, 2020

I'd scatter reinforcement of the idea at several places, since reference documents are often not read linearly, and "assert doesn't throw" is pretty unusual; in almost every other programming context, assert does throw.

I can make a PR in a day or so.

@novemberborn novemberborn assigned ghost Dec 15, 2020
@novemberborn
Copy link
Member

@f5lee fantastic, thank you.

@earthlyreason
Copy link

For reference, see also #1485

@sindresorhus sindresorhus mentioned this issue May 21, 2023
Closed
JigmetAvinash added a commit to JigmetAvinash/ava that referenced this issue Dec 4, 2023
@JigmetAvinash
Update 03-assertions.md
15110bf 
Adding text in assertion planning in order to inform about ava assertion not stopping even when they fail
linked to issue 
(document that ava assertions don't throw avajs#2624)
@JigmetAvinash JigmetAvinash mentioned this issue Dec 4, 2023
Closed
@novemberborn novemberborn closed this as not planned Won't fix, can't repro, duplicate, stale Dec 4, 2023
@novemberborn
Copy link
Member

Fixed by #3246.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted scope:assertions scope:documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@novemberborn @earthlyreason and others