Skip to content

Commit 0dd14e3

Browse files
committed
docs: Clarify Map
1 parent 897b094 commit 0dd14e3

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

src/map.rs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1+
/// The backing store for [`Config`][crate::Config]
2+
pub type Map<K, V> = InternalMap<K, V>;
3+
14
#[cfg(not(feature = "preserve_order"))]
2-
pub type Map<K, V> = std::collections::HashMap<K, V>;
5+
type InternalMap<K, V> = std::collections::HashMap<K, V>;
36
#[cfg(feature = "preserve_order")]
4-
pub type Map<K, V> = indexmap::IndexMap<K, V>;
7+
type InternalMap<K, V> = indexmap::IndexMap<K, V>;

src/source.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ use crate::value::{Value, ValueKind};
1313
pub trait Source: Debug {
1414
fn clone_into_box(&self) -> Box<dyn Source + Send + Sync>;
1515

16-
/// Collect all configuration properties available from this source and return
17-
/// a Map.
16+
/// Collect all configuration properties available from this source into
17+
/// a [`Map`].
1818
fn collect(&self) -> Result<Map<String, Value>>;
1919

2020
/// Collects all configuration properties to a provided cache.

0 commit comments

Comments
 (0)