Add doc string for format method

serde-rs · May 7, 2015 · 407cdc0 · 407cdc0
1 parent 8556c24
commit 407cdc0
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/src/de/mod.rs b/src/de/mod.rs
@@ -114,6 +114,11 @@ pub trait Deserializer {
         self.visit(visitor)
     }
 
+    /// Specify a format string for the deserializer.
+    ///
+    /// The deserializer format is used to determine which format
+    /// specific field attributes should be used with the
+    /// deserializer.
     fn format() -> &'static str {
         ""
     }

diff --git a/src/ser/mod.rs b/src/ser/mod.rs
@@ -180,6 +180,10 @@ pub trait Serializer {
         where K: Serialize,
               V: Serialize;
 
+    /// Specify a format string for the serializer.
+    ///
+    /// The serializer format is used to determine which format
+    /// specific field attributes should be used with the serializer.
     fn format() -> &'static str {
         ""
     }