From 72f002cc0a30f673761ee33884ba87e48aeab5ef Mon Sep 17 00:00:00 2001 From: Ty Overby Date: Tue, 13 Feb 2018 16:24:57 -0800 Subject: [PATCH] some comment fixes --- src/lib.rs | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 96d6a2c..e72ff25 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -64,8 +64,10 @@ pub trait SerializerAcceptor { /// Get a default configuration object. /// /// ### Default Configuration: -/// Byte limit: Unlimited -/// Endianness: Little +/// +/// | Byte limit | Endianness | +/// |------------|------------| +/// | Unlimited | Little | pub fn config() -> Config { Config::new() } @@ -114,7 +116,9 @@ where config().deserialize_from_custom(reader) } -/// TODO: document +/// Only use this if you know what you're doing. +/// +/// This is part of the public API. #[doc(hidden)] pub fn deserialize_in_place<'a, R, T>(reader: R, place: &mut T) -> Result<()> where