Skip to content

Commit c1680e8

Browse files
authored
docs: Mention comments and whitespace in format accessors (#124)
1 parent c904e02 commit c1680e8

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

src/document.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ impl KdlDocument {
193193
&mut self.nodes
194194
}
195195

196-
/// Gets the formatting details for this entry.
196+
/// Gets the formatting details (including whitespace and comments) for this entry.
197197
pub fn format(&self) -> Option<&KdlDocumentFormat> {
198198
self.format.as_ref()
199199
}

src/entry.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ impl KdlEntry {
112112
self.ty = Some(ty.into());
113113
}
114114

115-
/// Gets the formatting details for this entry.
115+
/// Gets the formatting details (including whitespace and comments) for this entry.
116116
pub fn format(&self) -> Option<&KdlEntryFormat> {
117117
self.format.as_ref()
118118
}

src/node.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ impl KdlNode {
246246
self.children_mut().as_mut().unwrap()
247247
}
248248

249-
/// Gets the formatting details for this node.
249+
/// Gets the formatting details (including whitespace and comments) for this node.
250250
pub fn format(&self) -> Option<&KdlNodeFormat> {
251251
self.format.as_ref()
252252
}

0 commit comments

Comments
 (0)