Clearer documentation for "No more mod.rs" #107
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
### No more `mod.rs` In Rust 2015, if you have a submodule: ```rust,ignore /// foo.rs /// or /// foo/mod.rs mod foo; ``` It can live in `foo.rs` or `foo/mod.rs`. If it has submodules of its own, it *must* be `foo/mod.rs`. So a `bar` submodule of `foo` would live at `foo/bar.rs`. In Rust 2018, `mod.rs` is no longer needed. ```rust,ignore /// foo.rs /// foo/bar.rs mod foo; /// in foo.rs mod bar; ``` `foo.rs` can just be `foo.rs`, and the submodule is still `foo/bar.rs`. This eliminates the special name, and if you have a bunch of files open in your editor, you can clearly see their names, instead of having a bunch of tabs named `mod.rs`.
steveklabnik
approved these changes
Sep 21, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No more
mod.rsIn Rust 2015, if you have a submodule:
It can live in
foo.rsorfoo/mod.rs. If it has submodules of its own, itmust be
foo/mod.rs. So abarsubmodule offoowould live atfoo/bar.rs.In Rust 2018,
mod.rsis no longer needed.foo.rscan just befoo.rs,and the submodule is still
foo/bar.rs. This eliminates the specialname, and if you have a bunch of files open in your editor, you can clearly
see their names, instead of having a bunch of tabs named
mod.rs.