Skip to content

docs: define the failing set_up_before_script contract#842

Merged
Chemaclass merged 1 commit into
mainfrom
docs/hook-failure-contract
Jul 20, 2026
Merged

docs: define the failing set_up_before_script contract#842
Chemaclass merged 1 commit into
mainfrom
docs/hook-failure-contract

Conversation

@Chemaclass

Copy link
Copy Markdown
Member

🤔 Background

Related #836

The docs described hook failure as "halts the file immediately" — accurate but incomplete now that #838 defined the full contract.

💡 Changes

  • Document that a failing set_up_before_script fails every test in the file, keeps totals consistent, and never stops the rest of the suite
  • Call out the trailing cmd && var=value guard footgun and the explicit-success idiom for optional-dependency skips

https://claude.ai/code/session_01JSeB8UzLCpqst55hAK6dED

Documents the behavior pinned in #838: hook failure marks every test
in the file as failed, totals stay consistent, the suite continues,
and a trailing `cmd && var=value` guard counts as hook failure — with
the explicit-success idiom for optional-dependency skips.

Claude-Session: https://claude.ai/code/session_01JSeB8UzLCpqst55hAK6dED
@Chemaclass Chemaclass added the documentation Improvements or additions to documentation label Jul 19, 2026
@Chemaclass Chemaclass self-assigned this Jul 19, 2026
@Chemaclass
Chemaclass merged commit 8854005 into main Jul 20, 2026
6 checks passed
@Chemaclass
Chemaclass deleted the docs/hook-failure-contract branch July 20, 2026 00:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant