Mention set_pledged_src_size in doc for include_contentsize

gyscos · Dec 23, 2021 · 821f10d · 821f10d
1 parent ec18c79
commit 821f10d
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/stream/mod.rs b/src/stream/mod.rs
@@ -115,7 +115,9 @@ macro_rules! encoder_common {
             ))
         }
 
-        /// Enables or disabled storing of the contentsize
+        /// Enables or disabled storing of the contentsize.
+        ///
+        /// Note that this only has an effect if the size is given with `set_pledged_src_size`.
         pub fn include_contentsize(
             &mut self,
             include_contentsize: bool,