Skip to content

Commit 3c9f4b8

Browse files
committed
Fix docs+formatting
1 parent e1c1476 commit 3c9f4b8

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

src/lib.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,6 @@ fn type_bits(mode: u32) -> u32 {
4949
/// ```
5050
/// assert_eq!(unix_mode::Type::from(0o0100640), unix_mode::Type::File);
5151
/// ```
52-
///
53-
/// It is not recommended to match against the [Type::Unknown] variant.
5452
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
5553
#[non_exhaustive]
5654
pub enum Type {
@@ -63,7 +61,9 @@ pub enum Type {
6361
CharDevice,
6462
/// Removed file in union filesystems
6563
Whiteout,
66-
#[doc(hidden)]
64+
/// File type not recognized by this version of this library
65+
///
66+
/// More types might be added in the future, so the semantics of this variant may change.
6767
Unknown,
6868
}
6969

@@ -278,7 +278,8 @@ mod unix_tests {
278278
// I don't know how to reliably find a block device across OSes, and
279279
// we can't make one (without root.)
280280
}
281-
/// Test predicates against files likely to already exist on a Unix system.
281+
282+
/// Test [is_allowed] against files likely to already exist on a Unix system.
282283
#[test]
283284
fn existing_file_perms() {
284285
use Access::*;

0 commit comments

Comments
 (0)