rust-lang / rust-lang/edition-guide
Explain that either foo/mod.rs or foo.rs is necessary
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 324
- Forks
- 152
- PR merge metrics
- No merged PRs in 30d
Description
The edition guide contains a chapter on Path Clarity (3.1.2), which explains that for a module foo with submodules, foo/mod.rs is no longer required. From the text, it is not clear foo.rs should be created instead.
Contributor guide
No contributing guide indexed for this repository
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 with the edition guide's Path Clarity chapter (3.1.2) and review the explanation of modules with submodules. Clarify that when foo/mod.rs is not used, foo.rs should be created instead, so the chapter explicitly explains the two valid file locations. Done means the required choice is clear from the chapter text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100