Skip to content

Commit

Permalink
docs: ✏️ minor tweaks to doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
DerZade committed Dec 4, 2023
1 parent 3cab0df commit 56de8a5
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions src/directory.rs
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ impl Directory {
/// # Arguments
/// * `input` - Reader including directory bytes
/// * `length` - Length of the directory (in bytes)
/// * `compression` - Compression of the directory
/// * `compression` - Compression of the directory
///
/// # Errors
/// Will return [`Err`] if `compression` is set to [`Compression::Unknown`], the data is not compressed correctly
Expand All @@ -219,7 +219,7 @@ impl Directory {
Self::from_reader_impl(input, length, compression)
}

/// Reads a directory from anything that can be turned into a byte slice (e.g. [`Vec<u8>`]).
/// Reads a directory from anything that can be turned into a byte slice (e.g. [`Vec<u8>`]).
///
/// # Arguments
/// * `bytes` - Input bytes
Expand Down Expand Up @@ -249,7 +249,7 @@ impl Directory {
/// # Arguments
/// * `input` - Reader including directory bytes
/// * `length` - Length of the directory (in bytes)
/// * `compression` - Compression of the directory
/// * `compression` - Compression of the directory
///
/// # Errors
/// Will return [`Err`] if `compression` is set to [`Compression::Unknown`], the data is not compressed correctly
Expand Down
4 changes: 2 additions & 2 deletions src/pmtiles.rs
Original file line number Diff line number Diff line change
Expand Up @@ -457,7 +457,7 @@ impl<R: Read + Seek> PMTiles<R> {
/// possible archive size.
///
/// This takes ownership of the object so all data does not need to be copied.
/// This prevents large memory consumption when writing large `PMTiles` archives.
/// This prevents large memory consumption when writing large `PMTiles` archives.
///
/// # Arguments
/// * `output` - Writer to write data to
Expand Down Expand Up @@ -608,7 +608,7 @@ impl<R: AsyncRead + AsyncSeekExt + Send + Unpin> PMTiles<R> {
/// possible archive size.
///
/// This takes ownership of the object so all data does not need to be copied.
/// This prevents large memory consumption when writing large `PMTiles` archives.
/// This prevents large memory consumption when writing large `PMTiles` archives.
///
/// # Arguments
/// * `output` - Writer to write data to
Expand Down

0 comments on commit 56de8a5

Please sign in to comment.