rust-lang / rust-lang/rust-by-example
Split.md seems wrong
Nobody has claimed this yet.
- Dominant language
- Handlebars
- Stars
- 8.1k
- Forks
- 1.6k
- PR merge metrics
- No merged PRs in 30d
Description
It is my understanding that mod statements in crate roots (main.rs, lib.rs, etc.) refer to root files in src/ but that those files' mod statements refer to root files in sub-directories of the same name as them. Essentially, crate roots share src/ for their modules but each sub module must have their own child folder to contain their own sub modules. Consequently...
main.rs
lib.rs
src/
args.rs
drill/
mod.rs
handle.rs
battery.rs
tool2.rs
hacksaw/
handle.rs
blade.rs
blade/
sawtooth.rs
pairing.rs
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading Split.md and compare its module-layout explanation with the Rust module structure described in this issue. Identify the part that conflicts with the reported understanding, then update the explanation and example so the intended layout is unambiguous; confirm that the resulting documentation addresses the issue's concern.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100