Skip to content

Commit 60f05f1

Browse files
committed
Add docs for distribution and metadata mods
1 parent a795913 commit 60f05f1

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

src/distribution.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,14 @@ use zip::ZipArchive;
66

77
use crate::{Error, Metadata};
88

9+
/// Python package distribution type
910
#[derive(Debug, Clone, Copy, PartialEq)]
1011
pub enum DistributionType {
12+
/// Source distribution
1113
SDist,
14+
/// Binary distribution egg format
1215
Egg,
16+
/// Binary distribution wheel format
1317
Wheel,
1418
}
1519

@@ -19,6 +23,7 @@ enum SDistType {
1923
TarGz,
2024
}
2125

26+
/// Python package distribution
2227
#[derive(Debug, Clone)]
2328
pub struct Distribution {
2429
dist_type: DistributionType,

src/metadata.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ use std::str::FromStr;
33
use crate::Error;
44
use mailparse::MailHeaderMap;
55

6+
/// Python package metadata
67
#[derive(Debug, Clone, Default, PartialEq)]
78
pub struct Metadata {
89
/// Version of the file format; legal values are “1.0”, “1.1”, “1.2”, “2.1” and “2.2”.

0 commit comments

Comments
 (0)