Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Fix docs
  • Loading branch information
sfackler committed Nov 1, 2014
1 parent de193c7 commit eadea0b
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 14 deletions.
4 changes: 4 additions & 0 deletions phf/src/lib.rs
Expand Up @@ -12,9 +12,13 @@ extern crate core;
extern crate collections;

pub use shared::PhfHash;
#[doc(inline)]
pub use map::Map;
#[doc(inline)]
pub use set::Set;
#[doc(inline)]
pub use ordered_map::OrderedMap;
#[doc(inline)]
pub use ordered_set::OrderedSet;

#[path="../../shared/mod.rs"]
Expand Down
4 changes: 1 addition & 3 deletions phf/src/map.rs
Expand Up @@ -17,9 +17,7 @@ use shared::PhfHash;
/// #[phase(plugin)]
/// extern crate phf_mac;
///
/// use phf::Map;
///
/// static MY_MAP: Map<&'static str, int> = phf_map! {
/// static MY_MAP: phf::Map<&'static str, int> = phf_map! {
/// "hello" => 10,
/// "world" => 11,
/// };
Expand Down
6 changes: 2 additions & 4 deletions phf/src/ordered_map.rs
Expand Up @@ -9,7 +9,7 @@ use collections::Map as MapTrait;

/// An order-preserving immutable map constructed at compile time.
///
/// Unlike a `PhfMap`, iteration order is guaranteed to match the definition
/// Unlike a `Map`, iteration order is guaranteed to match the definition
/// order.
///
/// `OrderedMap`s may be created with the `phf_ordered_map` macro:
Expand All @@ -20,9 +20,7 @@ use collections::Map as MapTrait;
/// #[phase(plugin)]
/// extern crate phf_mac;
///
/// use phf::OrderedMap;
///
/// static MY_MAP: OrderedMap<&'static str, int> = phf_ordered_map! {
/// static MY_MAP: phf::OrderedMap<&'static str, int> = phf_ordered_map! {
/// "hello" => 10,
/// "world" => 11,
/// };
Expand Down
6 changes: 2 additions & 4 deletions phf/src/ordered_set.rs
Expand Up @@ -8,7 +8,7 @@ use collections::Set as SetTrait;

/// An order-preserving immutable set constructed at compile time.
///
/// Unlike a `PhfSet`, iteration order is guaranteed to match the definition
/// Unlike a `Set`, iteration order is guaranteed to match the definition
/// order.
///
/// `OrderedSet`s may be created with the `phf_ordered_set` macro:
Expand All @@ -19,9 +19,7 @@ use collections::Set as SetTrait;
/// #[phase(plugin)]
/// extern crate phf_mac;
///
/// use phf::OrderedSet;
///
/// static MY_SET: OrderedSet<&'static str> = phf_ordered_set! {
/// static MY_SET: phf::OrderedSet<&'static str> = phf_ordered_set! {
/// "hello",
/// "world",
/// };
Expand Down
4 changes: 1 addition & 3 deletions phf/src/set.rs
Expand Up @@ -17,9 +17,7 @@ use map;
/// #[phase(plugin)]
/// extern crate phf_mac;
///
/// use phf::Set;
///
/// static MY_SET: Set<&'static str> = phf_set! {
/// static MY_SET: phf::Set<&'static str> = phf_set! {
/// "hello",
/// "world",
/// };
Expand Down

0 comments on commit eadea0b

Please sign in to comment.