Rearranged library layout to be cleaner. Updated docs and tests.

Author: James O'Cull

README.md

@@ -24,9 +24,7 @@ In your code...
 ```rust
 extern crate measurements;
 
-use measurements::length::Length;
-use measurements::temperature::Temperature;
-use measurements::weight::Weight;
+use measurements::{Length, Temperature, Weight};
 
 let football_field = Length::from_yards(100.0);
 let meters = football_field.as_meters();

src/length.rs

@@ -18,6 +18,16 @@ const METER_MILE_FACTOR: f64 = 0.000621371192237;
 
 /// The `Length` struct can be used to deal with lengths in a common way.
 /// Common metric and imperial units are supported.
+/// 
+/// # Example
+/// 
+/// ```
+/// use measurements::Length;
+/// 
+/// let football_field = Length::from_yards(100.0);
+/// let meters = football_field.as_meters();
+/// println!("There are {} meters in a football field.", meters);
+/// ```
 #[derive(Copy, Clone, Debug)]
 pub struct Length {
     meters: f64

src/lib.rs

@@ -1,81 +1,18 @@
-/// The `Measurement` trait and the `implement_measurement!` macro
-/// provides a common way for various measurements to be implemented.
-///
-/// # Example
-/// ```
-/// // Importing the `implement_measurement` macro from the external crate is important
-/// #[macro_use]
-/// extern crate measurements;
-/// 
-/// use measurements::measurement::*;
-/// 
-/// struct Cubits {
-///     forearms: f64
-/// }
-/// 
-/// impl Measurement for Cubits {
-///     fn get_base_units(&self) -> f64 {
-///         self.forearms
-///     }
-///     
-///     fn from_base_units(units: f64) -> Self {
-///         Cubits { forearms: units }
-///     }
-/// }
-///
-/// // Invoke the macro to automatically implement Add, Sub, etc...
-/// implement_measurement! { Cubits }
-///
-/// // The main function here is only included to make doc tests compile.
-/// // You should't need it in your own code.
-/// fn main() { }
-/// ```
 #[macro_use]
-pub mod measurement;
+mod measurement;
+pub use measurement::Measurement;
 
-/// The `Length` struct can be used to deal with lengths in a common way.
-/// Common metric and imperial units are supported.
-/// 
-/// # Example
-/// 
-/// ```
-/// use measurements::length::Length;
-/// 
-/// let football_field = Length::from_yards(100.0);
-/// let meters = football_field.as_meters();
-/// println!("There are {} meters in a football field.", meters);
-/// ```
 #[allow(dead_code)]
-pub mod length;
+mod length;
+pub use length::Length;
 
-/// The `Temperature` struct can be used to deal with temperatures in a common way.
-/// 
-/// # Example
-/// 
-/// ```
-/// use measurements::temperature::Temperature;
-/// 
-/// let boiling_water = Temperature::from_celsius(100.0);
-/// let fahrenheit = boiling_water.as_fahrenheit();
-/// println!("Boiling water measures at {} degrees fahrenheit.", fahrenheit);
-/// ```
 #[allow(dead_code)]
-pub mod temperature;
+mod temperature;
+pub use temperature::Temperature;
 
-/// The `Weight` struct can be used to deal with weights in a common way.
-/// 
-/// #Example
-/// 
-/// ```
-/// use measurements::weight::Weight;
-/// 
-/// let metric_ton = Weight::from_metric_tons(1.0);
-/// let united_states_tons = metric_ton.as_short_tons();
-/// let united_states_pounds = metric_ton.as_pounds();
-/// println!("One metric ton is {} U.S. tons - that's {} pounds!", united_states_tons, united_states_pounds);
-/// ```
 #[allow(dead_code)]
-pub mod weight;
+mod weight;
+pub use weight::Weight;
 
 // Include when running tests, but don't export them
 #[cfg(test)]

src/measurement.rs

@@ -1,8 +1,42 @@
+/// The `Measurement` trait and the `implement_measurement!` macro
+/// provides a common way for various measurements to be implemented.
+/// 
+/// # Example
+/// ```
+/// // Importing the `implement_measurement` macro from the external crate is important
+/// #[macro_use]
+/// extern crate measurements;
+/// 
+/// use measurements::Measurement;
+/// 
+/// struct Cubits {
+///     forearms: f64
+/// }
+/// 
+/// impl Measurement for Cubits {
+///     fn get_base_units(&self) -> f64 {
+///         self.forearms
+///     }
+///     
+///     fn from_base_units(units: f64) -> Self {
+///         Cubits { forearms: units }
+///     }
+/// }
+///
+/// // Invoke the macro to automatically implement Add, Sub, etc...
+/// implement_measurement! { Cubits }
+///
+/// // The main function here is only included to make doc tests compile.
+/// // You should't need it in your own code.
+/// fn main() { }
+/// ```
 pub trait Measurement {
     fn get_base_units(&self) -> f64;
     fn from_base_units(units: f64) -> Self;
 }
 
+/// This is a special macro that creates the code to implement
+/// operator and comparison overrides.
 #[macro_export]
 macro_rules! implement_measurement {
     ($($t:ty)*) => ($(

src/temperature.rs

@@ -1,6 +1,16 @@
 use super::measurement::*;
 
 /// The `Temperature` struct can be used to deal with temperatures in a common way.
+/// 
+/// # Example
+/// 
+/// ```
+/// use measurements::Temperature;
+/// 
+/// let boiling_water = Temperature::from_celsius(100.0);
+/// let fahrenheit = boiling_water.as_fahrenheit();
+/// println!("Boiling water measures at {} degrees fahrenheit.", fahrenheit);
+/// ```
 #[derive(Copy, Clone, Debug)]
 pub struct Temperature {
     kelvin: f64

src/weight.rs

@@ -1,6 +1,17 @@
 use super::measurement::*;
 
 /// The `Weight` struct can be used to deal with weights in a common way.
+/// 
+/// #Example
+/// 
+/// ```
+/// use measurements::Weight;
+/// 
+/// let metric_ton = Weight::from_metric_tons(1.0);
+/// let united_states_tons = metric_ton.as_short_tons();
+/// let united_states_pounds = metric_ton.as_pounds();
+/// println!("One metric ton is {} U.S. tons - that's {} pounds!", united_states_tons, united_states_pounds);
+/// ```
 #[derive(Copy, Clone, Debug)]
 pub struct Weight {
     kilograms: f64