improve level docs

This commit is contained in:
PgBiel 2025-06-10 01:53:43 -03:00
parent b997450a4b
commit 9139baf263
2 changed files with 12 additions and 6 deletions

View File

@ -470,9 +470,12 @@ pub struct GridHeader {
/// The level of the header. Must not be zero. /// The level of the header. Must not be zero.
/// ///
/// This is used during repetition multiple headers at once. When a header /// This allows repeating multiple headers at once. Headers with different
/// with a lower level starts repeating, all headers with a lower level stop /// levels can repeat together, as long as they have ascending levels.
/// repeating. ///
/// Notably, when a level with a lower level starts repeating, all higher
/// or equal level headers stop repeating (they are "replaced" by the new
/// header).
#[default(NonZeroU32::ONE)] #[default(NonZeroU32::ONE)]
pub level: NonZeroU32, pub level: NonZeroU32,

View File

@ -539,9 +539,12 @@ pub struct TableHeader {
/// The level of the header. Must not be zero. /// The level of the header. Must not be zero.
/// ///
/// This is used during repetition multiple headers at once. When a header /// This allows repeating multiple headers at once. Headers with different
/// with a lower level starts repeating, all headers with a lower level stop /// levels can repeat together, as long as they have ascending levels.
/// repeating. ///
/// Notably, when a level with a lower level starts repeating, all higher
/// or equal level headers stop repeating (they are "replaced" by the new
/// header).
#[default(NonZeroU32::ONE)] #[default(NonZeroU32::ONE)]
pub level: NonZeroU32, pub level: NonZeroU32,