bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

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

Browse source
This commit is contained in:
Alona Enraght-Moony 2025-02-01 19:57:59 +00:00
parent 9e48dfe5e0
commit 510de59dbd
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
src/rustdoc-json-types/lib.rs
View file

@ -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>,