doc/reference/index: Remove "Now that you have an overview" paragraph #4922
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 wording was originally from 58a1804 (At the end, point to docs that might be interesting next, 2016-05-17, rust-lang#2688), which added it to the end of the guide (where telling readers what they know makes some sense). It was moved to a "Cargo in Depth" section with 01aa9e3 ([src/doc/book] Move a paragraph to cargo-in-depth.md, 2017-08-31, rust-lang#4453), where it makes a bit less sense. When that section became the reference index in 3f2d93e ([doc/book] Create dir for book sections, 2017-08-31, rust-lang#4455) the context assumed by the paragraph was completely missing. This commit removes the paragraph, which doesn't reduce the usefulness of the reference index. And the removal avoids confusing readers who start with the reference docs and may now have the assumed overview.
|
(rust_highfive has picked a reviewer for you, use r? to override) |
|
@bors: r+ Thanks! |
|
📌 Commit 75f5172 has been approved by |
bors
added a commit
that referenced
this pull request
Jan 8, 2018
…lexcrichton doc/reference/index: Remove "Now that you have an overview" paragraph This wording was originally from 58a1804 (#2688), which added it to the end of the guide (where telling readers what they know makes some sense). It was moved to a "Cargo in Depth" section with 01aa9e3 (#4453), where it makes a bit less sense. When that section became the reference index in 3f2d93e (#4455) the context assumed by the paragraph was completely missing. This commit removes the paragraph, which doesn't reduce the usefulness of the reference index. And the removal avoids confusing readers who start with the reference docs and may now have the assumed overview.
|
☀️ Test successful - status-appveyor, status-travis |
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.
This wording was originally from 58a1804 (#2688), which added it to the end of the guide (where telling readers what they know makes some sense). It was moved to a "Cargo in Depth" section with 01aa9e3 (#4453), where it makes a bit less sense. When that section became the reference index in 3f2d93e (#4455) the context assumed by the paragraph was completely missing.
This commit removes the paragraph, which doesn't reduce the usefulness of the reference index. And the removal avoids confusing readers who start with the reference docs and may now have the assumed overview.