Skip to content

Update rustdoc internals #1271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 9, 2021
Merged

Update rustdoc internals #1271

merged 1 commit into from
Dec 9, 2021

Conversation

jsha
Copy link
Contributor

@jsha jsha commented Dec 5, 2021

Use current paths when discussing source files.
Update cheat sheet section with download-rustc.
Add "use cases" section.

@camelid
Copy link
Member

camelid commented Dec 5, 2021

@jyn514 says on Zulip:

please don't merge until I get a chance to write them down, I'll try to do that tomorrow

(Reposting here so we don't forget.)

@camelid camelid added the S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content label Dec 5, 2021
@jyn514 jyn514 added S-waiting-on-author Status: this PR is waiting for additional action by the OP and removed S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content labels Dec 7, 2021
@camelid camelid self-assigned this Dec 8, 2021
@jsha jsha force-pushed the update-rustdoc branch 2 times, most recently from 0067f6f to 37dda5c Compare December 8, 2021 02:13
@jsha
Copy link
Contributor Author

jsha commented Dec 8, 2021

Great feedback, thanks! I've responded to it all. I also updated some of the sentences in cheat sheet so they consistently use the imperative mood.

Copy link
Member

@jyn514 jyn514 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me :) I think there's a little more detail in the "use cases" section than necessary but everything else is amazing and I don't want to block it.

Use current paths when discussing source files.
Update cheat sheet section with download-rustc.
Add "use cases" section.
@camelid camelid added S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content and removed S-waiting-on-author Status: this PR is waiting for additional action by the OP labels Dec 8, 2021
@camelid
Copy link
Member

camelid commented Dec 9, 2021

I haven't looked at all the changes, but nothing stands out to me from skimming, so feel free to merge if you want @jyn514 :)

@jyn514 jyn514 merged commit f9db2f4 into rust-lang:master Dec 9, 2021
@jyn514
Copy link
Member

jyn514 commented Dec 9, 2021

Thanks @jsha for working on this!

@jsha jsha deleted the update-rustdoc branch December 9, 2021 22:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants