[ShahakShama]

Note

Low Risk
Low risk documentation-only change; no code behavior or APIs are modified.

Overview
Updates style.md to add a dedicated expect message section explaining how to write invariant-focused expect(...) strings, with revised BAD/GOOD examples.

Removes the older, more boilerplate expect guidance from the Assertions section so the rule is centralized and more detailed.

^{Written by Cursor Bugbot for commit ddb96e3. This will update automatically on new commits. Configure here.}

[reviewable-StarkWare]

This change is 

[ShahakShama]

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

• add comment in return value section to split checking the value and performing action to 2 lines #13144 : 2 dependent PRs (#13145 , #13146 )
• remove bad example in foo_or_else section #13141
• improve the starting paragraphs of testing section #13139
• improve macros section #13137
• remove unnecessary misc sections #13131
• reorder sections (move AI and Testing up) #13118
• remove open issues section #13115
• improve external dependencies section #13114
• remove github smell testing section #13113
• create misc section, move stuff into it, and order by importance (no erasure of anything yet) #13112
• change file layout section #13078
• add section on sleep in tests #13073
• add section on dependency injection #13072
• move expect message to a separate section with more explanation #13071 👈 (View in Graphite)
• add directory layout section #12950
• rename allocations and add &Option<T> #12781
• remove laziness  #11591
• rewrite types section #11588
• more comments  #11587
• more comments  #11586
• more comments  #11585
• more comments  #11584
• arithmetic: remove ditto for other mathematical operations. #11848
• gilad/style-guide

This stack of pull requests is managed by Graphite. Learn more about stacking.

[ShahakShama]

+r:@Stavbe

@ShahakShama made 1 comment.
Reviewable status: 0 of 1 files reviewed, all discussions resolved (waiting on Stavbe).

[Stavbe]

@Stavbe made 1 comment.
Reviewable status: 0 of 1 files reviewed, 1 unresolved discussion (waiting on ShahakShama).

---

style.md line 120 at r1 (raw file):

// GOOD
// This message is written for the code reader, and explains why the error should never happen.
std::env::var("IMPORTANT_PATH").expect("set by wrapper_script.sh at startup");

IMPORTANT_PATH should have been set by .....

Code quote:

"set by wrapper_script.sh at startup"

[ShahakShama]

@ShahakShama made 1 comment.
Reviewable status: 0 of 1 files reviewed, 1 unresolved discussion (waiting on Stavbe).

---

style.md line 120 at r1 (raw file):

Previously, Stavbe wrote…

IMPORTANT_PATH should have been set by .....

This is intended. Explained above

[Stavbe]

@Stavbe reviewed 1 file and all commit messages, and resolved 1 discussion.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on ShahakShama).

[github-actions]

There hasn't been any activity on this pull request recently, and in order to prioritize active work, it has been marked as stale.
This PR will be closed and locked in 7 days if no further activity occurs.
Thank you for your contributions!