proposed copy edits to rustdoc chapter #150
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
|
So doxidize is officially the future rustdoc 2? |
|
@steveklabnik ^^ What, if anything, should be said about future-rustdoc? |
nikomatsakis
approved these changes
Jun 8, 2018
|
I think, for now, we should simply remove the references to this project. It's not in a state where we want people to poke at it, and it's not going to be until the fall, at least. |
mark-i-m
suggested changes
Jun 9, 2018
src/rustdoc.md
Outdated
| @@ -4,7 +4,7 @@ Rustdoc actually uses the rustc internals directly. It lives in-tree with the | |||
| compiler and standard library. This chapter is about how it works. (A new | |||
| implementation is also [under way], though). | |||
There was a problem hiding this comment.
Could you change this to something more vague (as per #150 (comment))
Perhaps something like "There have been some attempts to rewrite rustdoc, but they are in early stages".
|
Ping @zackmdavis |
The current directory is typically not on the user's $PATH.
Steve says it's not ready (rust-lang#150 (comment)).
zackmdavis
force-pushed
the
rustdoc_chapter_edits
branch
from
580b72c to
824c5c2
Compare
|
@mark-i-m pong (just scrapped the sentence entirely) |
mark-i-m
approved these changes
Jun 26, 2018
|
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.
(updating a link, and making commands more literally copy-pasteable)