Skip to content

rustdoc-json-types: Document that crate name isn't package name. #136396

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

Merged
merged 1 commit into from
Feb 5, 2025
Merged

rustdoc-json-types: Document that crate name isn't package name. #136396

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
7 changes: 7 additions & 0 deletions src/rustdoc-json-types/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,13 @@ pub struct Crate {
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct ExternalCrate {
/// The name of the crate.
///
/// Note: This is the [*crate* name][crate-name], which may not be the same as the
/// [*package* name][package-name]. For example, for <https://crates.io/crates/regex-syntax>,
/// this field will be `regex_syntax` (which uses an `_`, not a `-`).
///
/// [crate-name]: https://doc.rust-lang.org/stable/cargo/reference/cargo-targets.html#the-name-field
/// [package-name]: https://doc.rust-lang.org/stable/cargo/reference/manifest.html#the-name-field
pub name: String,
/// The root URL at which the crate's documentation lives.
pub html_root_url: Option<String>,
Expand Down
Loading