Skip to content

Commit e287f43

Browse files
committed
crates-io: Add doc comment for NewCrate struct
1 parent 5a2ea19 commit e287f43

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

crates/crates-io/lib.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@ pub struct Crate {
3838
pub max_version: String,
3939
}
4040

41+
/// This struct is serialized as JSON and sent as metadata ahead of the crate
42+
/// tarball when publishing crates to a crate registry like crates.io.
43+
///
44+
/// see <https://doc.rust-lang.org/cargo/reference/registry-web-api.html#publish>
4145
#[derive(Serialize, Deserialize)]
4246
pub struct NewCrate {
4347
pub name: String,

0 commit comments

Comments
 (0)