add comment on message::Builder::new_default()

capnproto · Sep 20, 2022 · e342ce2 · e342ce2
1 parent 551dcdf
commit e342ce2
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/capnp/src/message.rs b/capnp/src/message.rs
@@ -649,6 +649,8 @@ fn test_allocate_max() {
 }
 
 impl Builder<HeapAllocator> {
+    /// Constructs a new `message::Builder<HeapAllocator>` whose first segment has length
+    /// `SUGGESTED_FIRST_SEGMENT_WORDS`.
     pub fn new_default() -> Builder<HeapAllocator> {
         Builder::new(HeapAllocator::new())
     }