Skip to content

Commit fee0ef4

Browse files
committed
📝 Add PNA chunk naming convention docs
Expanded documentation for faCe and faCl chunk types to clarify their naming conventions according to PNA standards, explaining the semantic meaning of each character's case.
1 parent 1ca820a commit fee0ef4

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

cli/src/chunk/acl.rs

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,21 @@ use std::{
88
str::{FromStr, Utf8Error, from_utf8},
99
};
1010

11-
/// [ChunkType] File Access Control Entry
11+
/// Private chunk type for File Access Control Entry.
12+
/// Name follows PNA chunk naming convention where case has semantic meaning:
13+
/// - lowercase first letter: ancillary (not critical)
14+
/// - lowercase second letter: private (not public)
15+
/// - uppercase third letter: reserved
16+
/// - lowercase fourth letter: safe to copy
1217
#[allow(non_upper_case_globals)]
1318
pub const faCe: ChunkType = unsafe { ChunkType::from_unchecked(*b"faCe") };
1419

15-
/// [ChunkType] File Access Control List
20+
/// Private chunk type for File Access Control List.
21+
/// Name follows PNA chunk naming convention where case has semantic meaning:
22+
/// - lowercase first letter: ancillary (not critical)
23+
/// - lowercase second letter: private (not public)
24+
/// - uppercase third letter: reserved
25+
/// - lowercase fourth letter: safe to copy
1626
#[allow(non_upper_case_globals)]
1727
pub const faCl: ChunkType = unsafe { ChunkType::from_unchecked(*b"faCl") };
1828

0 commit comments

Comments
 (0)