[ShahakShama]

Note

Low Risk
Low risk because changes are documentation-only, but they may influence future code organization conventions across the repo.

Overview
Adds a new Directory Layout section to style.md that standardizes when to use foo.rs vs foo/mod.rs, requires mod.rs to be declaration-only, and documents where to put unit test files (including a #[path] pattern for single-file modules).

Removes the prior guideline to avoid mod.rs, effectively shifting the recommended module layout conventions.

^{Written by Cursor Bugbot for commit e8dfc47. 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
• add directory layout section #12950 👈 (View in Graphite)
• 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.

[Stavbe]

@Stavbe made 2 comments.
Reviewable status: 0 of 1 files reviewed, 2 unresolved discussions (waiting on ShahakShama).

---

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

## Directory Layout

Single-file modules use `foo.rs`. Modules with submodules use `foo/mod.rs`.

WDYM by use?

---

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

For a single-file module `foo.rs`, place tests in `foo_test.rs` in the same directory.

Use the `#[path]` attribute to make it a submodule of `foo`:

Do we have an explanation for why do we want this?

[ShahakShama]

@ShahakShama made 2 comments.
Reviewable status: 0 of 1 files reviewed, 2 unresolved discussions (waiting on Stavbe).

---

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

Previously, Stavbe wrote…

WDYM by use?

Done.

---

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

Previously, Stavbe wrote…

Do we have an explanation for why do we want this?

This is what we agreed with the goldbergs. If you want we can re-open this

[Stavbe]

@Stavbe made 3 comments.
Reviewable status: 0 of 1 files reviewed, 4 unresolved discussions (waiting on ShahakShama).

---

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

Previously, ShahakShama wrote…

This is what we agreed with the goldbergs. If you want we can re-open this

Yes, I remember. I just think it is good to add an explanation of the `#[path]' attribute.

---

style.md line 77 at r2 (raw file):

## Directory Layout

Single-file modules should be in a file called `foo.rs`. Modules with submodules should be in a file called `foo/mod.rs`.

<module_name>.rs

Code quote:

foo.rs

---

style.md line 79 at r2 (raw file):

Single-file modules should be in a file called `foo.rs`. Modules with submodules should be in a file called `foo/mod.rs`.

`mod.rs` should not contain any code — it should only declare submodules.

This contradicts the previous sentence:
Modules with submodules should be in a file called foo/mod.rs
I think you mean that "Modules with submodules should be in a directory called foo that contains a file called mod.ts that contains...

Code quote:

`mod.rs` should not contain any code — it should only declare submodules.

[ShahakShama]

@ShahakShama made 3 comments.
Reviewable status: 0 of 1 files reviewed, 4 unresolved discussions (waiting on Stavbe).

---

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

Previously, Stavbe wrote…

Yes, I remember. I just think it is good to add an explanation of the `#[path]' attribute.

added an explanation that this makes the test a submodule and gives private access

---

style.md line 77 at r2 (raw file):

Previously, Stavbe wrote…

<module_name>.rs

You mean throughout the entire section or here specifically. If throughout I'm ok with this change even though I think it's less better. If only here it will break consistency

---

style.md line 79 at r2 (raw file):

Previously, Stavbe wrote…

This contradicts the previous sentence:
Modules with submodules should be in a file called foo/mod.rs
I think you mean that "Modules with submodules should be in a directory called foo that contains a file called mod.ts that contains...

Yes, that's what I meant, but it's clear that I mean modules with submodules from the fact I wrote mod.rs and not foo.rs
The sentence you wrote is too long IMO. I think this way is clear enough

[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!