Skip to content

Commit e93f808

Browse files
committed
Update doc comment
1 parent 574d003 commit e93f808

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

gix-object/src/tree/mod.rs

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -326,16 +326,14 @@ impl Ord for EntryRef<'_> {
326326
}
327327
}
328328

329-
/// TODO
330-
/// Keep the following constraints in mind:
329+
/// A wrapper for `BString`. It is used to enforce the following constraints:
331330
///
332331
/// - The path separator always is `/`, independent of the platform.
333332
/// - Only normal components are allowed.
334-
/// - This is always represented as a bunch of bytes.
333+
/// - It is always represented as a bunch of bytes.
335334
#[derive(Clone, Debug, Eq, PartialEq, Hash)]
336335
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
337336
pub struct RepositoryPathPuf {
338-
/// TODO
339337
inner: BString,
340338
}
341339

0 commit comments

Comments
 (0)