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.

Sign up for GitHub

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

Jump to bottom

fix typo in rustdoc/src/what-is-rustdoc.md #112741

Merged
merged 1 commit into from
Jul 17, 2023
Merged

fix typo in rustdoc/src/what-is-rustdoc.md #112741

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/doc/rustdoc/src/what-is-rustdoc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ top, with no contents.
## Configuring rustdoc

There are two problems with this: first, why does it
think that our package is named "lib"? Second, why does it not have any
think that our crate is named "lib"? Second, why does it not have any
contents?
Comment on lines 39 to 41
Copy link
Member

Choose a reason for hiding this comment

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

It is not immediately clear to me that this is a typo, as Rust has packages and packages are not crates, see https://doc.rust-lang.org/book/ch07-01-packages-and-crates.html

Copy link
Contributor Author

Choose a reason for hiding this comment

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

https://github.com/rust-lang/rust/pull/112741/files#diff-3a33d0f38f7a3cd5deb856ff984abfbcdcdb5adc9203734e739a1572ca2a3a1fR34

According to the description of the context, I think it is more appropriate to use crate.

Copy link
Member

Choose a reason for hiding this comment

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

Oh, well-spotted!


The first problem is due to `rustdoc` trying to be helpful; like `rustc`,
Expand Down