Skip to content
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

Change "Cargo Doc" section to "Rustdoc" on tools page #1255

Open
camelid opened this issue Aug 31, 2020 · 3 comments
Open

Change "Cargo Doc" section to "Rustdoc" on tools page #1255

camelid opened this issue Aug 31, 2020 · 3 comments
Labels
A-Content The written content on the website. C-Bug Something isn't working.

Comments

@camelid
Copy link
Member

camelid commented Aug 31, 2020

What needs to be fixed?

Currently on the tools page, it says:

image

"Cargo Doc" seems a bit out of place given that another section is shown as "Rustfmt", when usually you use it as cargo fmt.

Page(s) Affected

/tools

Suggested Improvement

Change "Cargo Doc" to "Rustdoc"

Side Note

Also add cargo fmt to this list on /learn/getting-started?

image

@camelid camelid added A-Content The written content on the website. C-Bug Something isn't working. labels Aug 31, 2020
@Manishearth
Copy link
Member

I'm not sure I agree, the name rustdoc is not as popular in the rust community since people never directly invoke it, whereas people are kinda used to the names rustfmt and clippy.

@camelid
Copy link
Member Author

camelid commented Sep 1, 2020

But this page is mostly for new contributors who won't necessarily know the names clippy and rustfmt anyway, right? That's why it explains what they do. And calling it Rustdoc will probably get more people more familiar with it.

@Manishearth
Copy link
Member

@camelid Yes, but the point is that you want to teach people the terms other people will use, so that they do not have to learn a second thing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Content The written content on the website. C-Bug Something isn't working.
Projects
None yet
Development

No branches or pull requests

2 participants