path-clarity: Document new uniform paths variant #74
Conversation
This file contains 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
This was referenced Aug 3, 2018
Centril
suggested changes
Aug 3, 2018
| Note: During the 2018 edition preview, there are two variants of the module | ||
| system under consideration, the "absolute use paths" variant and the "relative | ||
| paths" variant. Most of these changes apply to both variants; the two variant | ||
| sections call out the differences between the two. We would encourage testing |
There was a problem hiding this comment.
s/we would encourage/we encourage
| * Absolute paths begin with a crate name, where the keyword `crate` | ||
| refers to the current crate. | ||
| * The `crate` keyword refers to the current crate. | ||
| * Relative paths variant: Paths work uniformly in both `use` statements and in |
There was a problem hiding this comment.
I think use should be referred to as an item and not a statement, https://doc.rust-lang.org/reference/items/use-declarations.html
| ### Absolute paths begin with `crate` or the crate name | ||
| ### The `crate` keyword refers to the current crate. | ||
|
|
||
| In `use` statements and in other code, you can refer to the root of the current |
| ### Relative paths variant | ||
|
|
||
| The relative paths variant of Rust 2018 simplifies and unifies path handling | ||
| compared to Rust 2015. In Rust 2015, paths work differently in use statements |
|
|
||
| The relative paths variant of Rust 2018 simplifies and unifies path handling | ||
| compared to Rust 2015. In Rust 2015, paths work differently in use statements | ||
| than they do elsewhere. In particular, paths in `use` statements would always |
| module, which meant that everything would seem straightforward until working on | ||
| a project large enough to have submodules. | ||
|
|
||
| In the relative paths variant of Rust 2018, paths in `use` statements and in |
| let five = std::sync::Arc::new(5); | ||
| } | ||
| } | ||
| ``` |
There was a problem hiding this comment.
An example with enums would be beneficial here to illustrate self::
|
|
||
| ### Absolute use paths variant | ||
|
|
||
| In the absolute use paths variant of Rust 2018, paths in `use` statements |
joshtriplett
force-pushed
the
relative-paths
branch
from
41e7074
to
d074c9d
Compare
|
Note that this should not get merged until some version of rust-lang/rust#52923 gets merged. We also need to document how to test the two different variants. |
Centril
approved these changes
Aug 3, 2018
joshtriplett
force-pushed
the
relative-paths
branch
from
883030c
to
159bf86
Compare
joshtriplett
changed the title
Centril
reviewed
Aug 3, 2018
| paths" variant. Most of these changes apply to both variants; the two variant | ||
| sections call out the differences between the two. We encourage testing of the | ||
| new "relative paths" variant introduced in edition preview 2. The release of | ||
| new "uniform paths" variant introduced in edition preview 2. The release of | ||
| the 2018 edition will use one of these two variants. |
There was a problem hiding this comment.
Perhaps: "Once the Rust 2018 is released, only one of these two variants will be stabilized and available".
|
@joshtriplett can you rebase this one? :) |
For the final Rust 2018 release, we can delete the section that doesn't apply, and change the various qualified references like "the relative paths variant of Rust 2018" to just "Rust 2018".
…solute" Describe the new variant as "uniform paths", and the previous variant as "anchored use paths". These names both highlight the primary benefit of each variant, and avoid describing paths including "self" or "super" as "absolute".
joshtriplett
force-pushed
the
relative-paths
branch
from
f14eee9
to
42654b6
Compare
|
@Centril Done. |
|
Neat :) I'll go ahead and merge this. Thanks! |
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.
For the final Rust 2018 release, we can delete the section that doesn't
apply, and change the various qualified references like "the uniform
paths variant of Rust 2018" to just "Rust 2018".