Skip to content

Commit 810d629

Browse files
committed
docs: Further cleanup
1 parent 0dd14e3 commit 810d629

File tree

3 files changed

+8
-10
lines changed

3 files changed

+8
-10
lines changed

src/builder.rs

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -125,9 +125,8 @@ enum SourceType {
125125
impl BuilderState for DefaultState {}
126126
impl BuilderState for AsyncState {}
127127

128+
/// Operations allowed in any state
128129
impl<St: BuilderState> ConfigBuilder<St> {
129-
// operations allowed in any state
130-
131130
/// Set a default `value` at `key`
132131
///
133132
/// This value can be overwritten by any [`Source`], [`AsyncSource`] or override.
@@ -183,9 +182,8 @@ impl<St: BuilderState> ConfigBuilder<St> {
183182
}
184183
}
185184

185+
/// Operations allowed in sync state
186186
impl ConfigBuilder<DefaultState> {
187-
// operations allowed in sync state
188-
189187
/// Registers new [`Source`] in this builder.
190188
///
191189
/// Calling this method does not invoke any I/O. [`Source`] is only saved in internal register for later use.
@@ -273,9 +271,8 @@ impl ConfigBuilder<DefaultState> {
273271
}
274272
}
275273

274+
/// Operations allowed in async state
276275
impl ConfigBuilder<AsyncState> {
277-
// operations allowed in async state
278-
279276
/// Registers new [`Source`] in this builder.
280277
///
281278
/// Calling this method does not invoke any I/O. [`Source`] is only saved in internal register for later use.

src/config.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ use crate::ser::ConfigSerializer;
1111
use crate::source::Source;
1212
use crate::value::{Table, Value};
1313

14-
/// A prioritized configuration repository. It maintains a set of
15-
/// configuration sources, fetches values to populate those, and provides
14+
/// A prioritized configuration repository.
15+
///
16+
/// It maintains a set of configuration sources, fetches values to populate those, and provides
1617
/// them according to the source's priority.
1718
#[derive(Clone, Debug)]
1819
pub struct Config {

src/value.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ use crate::map::Map;
99

1010
/// Underlying kind of the configuration value.
1111
///
12-
/// Standard operations on a `Value` by users of this crate do not require
13-
/// knowledge of `ValueKind`. Introspection of underlying kind is only required
12+
/// Standard operations on a [`Value`] by users of this crate do not require
13+
/// knowledge of [`ValueKind`]. Introspection of underlying kind is only required
1414
/// when the configuration values are unstructured or do not have known types.
1515
#[derive(Debug, Clone, PartialEq)]
1616
pub enum ValueKind {

0 commit comments

Comments
 (0)