Skip to content

Commit 17de6dd

Browse files
authored
Fix vertical spacing in API doc (#70)
1 parent 02512eb commit 17de6dd

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/lib.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,14 +131,17 @@ pub enum Error {
131131
#[error("conflict of partition GUIDs")]
132132
ConflictPartitionGUID,
133133
/// An error that occurs when a partition has an invalid boundary.
134+
///
134135
/// The end sector must be greater or equal to the start sector of the partition.
136+
///
135137
/// Partitions must fit within the disk and must not overlap.
136138
#[error(
137139
"invalid partition boundaries: partitions must have positive size, must not overlap, \
138140
and must fit within the disk"
139141
)]
140142
InvalidPartitionBoundaries,
141143
/// An error that occurs when the user provide an invalid partition number.
144+
///
142145
/// The partition number must be between 1 and `number_of_partition_entries` (usually 128)
143146
/// included.
144147
#[error("invalid partition number: {0}")]
@@ -874,8 +877,10 @@ impl GPT {
874877
}
875878

876879
/// Find free spots in the partition table.
880+
///
877881
/// This function will return a vector of tuple with on the left: the starting LBA of the free
878882
/// spot; and on the right: the size (in sectors) of the free spot.
883+
///
879884
/// This function will automatically align with the alignment defined in the `GPT`.
880885
///
881886
/// # Examples
@@ -964,6 +969,7 @@ impl GPT {
964969

965970
/// Find the last place (most on the right) where you could start a new partition of the size
966971
/// given in parameter.
972+
///
967973
/// This function will automatically align with the alignment defined in the `GPT`.
968974
///
969975
/// # Examples

0 commit comments

Comments
 (0)