Commit 510de59

committed

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

1 parent 9e48dfe commit 510de59Copy full SHA for 510de59

File tree

-0

lines changed

-0

lines changed

Lines changed: 7 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,13 @@ pub struct Crate {`
`61`	`61`	`#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]`
`62`	`62`	`pub struct ExternalCrate {`
`63`	`63`	`/// The name of the crate.`
	`64`	`+ ///`
	`65`	`+ /// Note: This is the [crate name][crate-name], which may not be the same as the`
	`66`	`+ /// [package name][package-name]. For example, for <https://crates.io/crates/regex-syntax>,`
	`67`	+ /// this field will be `regex_syntax` (which uses an `_`, not a `-`).
	`68`	`+ ///`
	`69`	`+ /// [crate-name]: https://doc.rust-lang.org/stable/cargo/reference/cargo-targets.html#the-name-field`
	`70`	`+ /// [package-name]: https://doc.rust-lang.org/stable/cargo/reference/manifest.html#the-name-field`
`64`	`71`	`pub name: String,`
`65`	`72`	`/// The root URL at which the crate's documentation lives.`
`66`	`73`	`pub html_root_url: Option<String>,`

Comments

(0)