From 22c3df76251ec5cfb8d706fe655399f5df0c5e75 Mon Sep 17 00:00:00 2001 From: Jake Goulding Date: Thu, 9 Feb 2017 10:09:20 -0500 Subject: [PATCH 1/3] Grammar on Value doc strings --- src/value.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/value.rs b/src/value.rs index 4769ef1..99e6d23 100644 --- a/src/value.rs +++ b/src/value.rs @@ -103,7 +103,7 @@ impl Value { match *self { Value::Float(f) => Some(f), _ => None } } - /// Tests whether this value is an float + /// Tests whether this value is a float pub fn is_float(&self) -> bool { self.as_float().is_some() } @@ -113,7 +113,7 @@ impl Value { match *self { Value::Boolean(b) => Some(b), _ => None } } - /// Tests whether this value is an boolg + /// Tests whether this value is a boolean pub fn is_bool(&self) -> bool { self.as_bool().is_some() } @@ -140,7 +140,7 @@ impl Value { match *self { Value::Datetime(ref s) => Some(s), _ => None } } - /// Tests whether this value is an datetime + /// Tests whether this value is a datetime pub fn is_datetime(&self) -> bool { self.as_datetime().is_some() } From f49d0b3246f26b38f9f8a91802a33011b17ff0ad Mon Sep 17 00:00:00 2001 From: Jake Goulding Date: Thu, 9 Feb 2017 10:12:23 -0500 Subject: [PATCH 2/3] Tighten up the crate-level docs --- src/lib.rs | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index d2034e7..87e090d 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -2,8 +2,8 @@ //! //! [TOML]: https://github.com/toml-lang/toml //! -//! This library implements a [TOML] v0.4.0 compatible parser. This crate also -//! primarily supports the [`serde`] library for encoding/decoding support to +//! This library implements a [TOML] v0.4.0 compatible parser, +//! primarily supporting the [`serde`] library for encoding/decoding //! various types in Rust. //! //! TOML itself is a simple, ergonomic, and readable configuration format: @@ -37,8 +37,8 @@ //! } //! ``` //! -//! You'll note that TOML is very similar to JSON with the notable addition of a -//! `Datetime` type. In general TOML and JSON are interchangeable in terms of +//! TOML is similar to JSON with the notable addition of a `Datetime` +//! type. In general, TOML and JSON are interchangeable in terms of //! formats. //! //! ## Parsing TOML @@ -53,14 +53,15 @@ //! assert_eq!(value["foo"].as_str(), Some("bar")); //! ``` //! -//! The `Value` type implements a number of convenience methods and traits, -//! where the example above is using `FromStr` to parse a `str` into a `Value`. +//! The `Value` type implements a number of convenience methods and +//! traits; the example above uses `FromStr` to parse a `str` into a +//! `Value`. //! //! ## Deserialization and Serialization //! -//! This crate currently supports [`serde`] 0.9 with a number of +//! This crate supports [`serde`] 0.9 with a number of //! implementations of the `Deserialize`, `Serialize`, `Deserializer`, and -//! `Serializer` traits. Namely, you'll find in this crate: +//! `Serializer` traits. Namely, you'll find: //! //! * `Deserialize for Value` //! * `Serialize for Value` @@ -71,8 +72,8 @@ //! * `Serializer for ser::Serializer` //! * `Deserializer for Value` //! -//! This notably means that you can use Serde to deserialize/serialize the -//! `Value` type as well as the `Datetime` type in this crate. Similarly you can +//! This means that you can use Serde to deserialize/serialize the +//! `Value` type as well as the `Datetime` type in this crate. You can also //! use the `Deserializer`, `Serializer`, or `Value` type itself to act as //! a deserializer/serializer for arbitrary types. //! @@ -112,7 +113,7 @@ //! } //! ``` //! -//! Similarly you can serialize types in a similar fashion: +//! You can serialize types in a similar fashion: //! //! ```rust //! #[macro_use] From 90630d66fb84900181c3f1af64ae5d3044702045 Mon Sep 17 00:00:00 2001 From: Jake Goulding Date: Thu, 9 Feb 2017 10:41:58 -0500 Subject: [PATCH 3/3] Remove newline that causes strange rendering --- src/lib.rs | 1 - 1 file changed, 1 deletion(-) diff --git a/src/lib.rs b/src/lib.rs index 87e090d..4a27c7c 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -67,7 +67,6 @@ //! * `Serialize for Value` //! * `Deserialize for Datetime` //! * `Serialize for Datetime` -//! //! * `Deserializer for de::Deserializer` //! * `Serializer for ser::Serializer` //! * `Deserializer for Value`