chapter 7-3: clarify absolute and relative paths - #4831
Open
karolinepauls wants to merge 1 commit into
Open
karolinepauls wants to merge 1 commit into
karolinepauls wants to merge 1 commit into
Conversation
This branch has not been deployed
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
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.
Generally, less can do more if "less" brings clarity. This diff actually removes more words than it adds, though the line count increased due to added structure.
Changes:
Added a short and gentle intro sentence, which states what the section will focus on:
1.1. Removed sentence - redundant with the listing which already includes the
// Absolute pathcomment:1.2. Removed sentence (non sequitur) - the specifics of the example don't determine that we can use
crateto start an absolute path. The way Rust works determines that.1.3: The intro is now followed by two single-sentence descriptions of the two calls from the listing. Both follow a similar structure and are kept in separate paragraphs for presentation reasons.
2.2. Filesystem path analogy removed. It is obvious at this point, since the previous chapter illustrated it. At the same time, it bloats the text and makes it impossible to view the following absolute/relative path discussion and the listing at the same time.
Broken down into parts, reordered, added structure (headers and a list). Added style to highlight the contrast between absolute and relative paths.
3.1. Sentence removed, since this file already states it at the beginning (and the structure conveys it anyway):
Sidenote: I think that "means" here expresses an induction (
=>) rather than equivalence<=>, since members of the same module can refer to each other (or themselves) by name, without their module name.Absolute and relative paths. I haven't thought about this header much.