Skip to content

Commit

Permalink
documentation changes
Browse files Browse the repository at this point in the history
Very big lines as a first line are bad, because they break on docs.
Keep first line, as a summary, very simple.
  • Loading branch information
Glauber Costa authored and Glauber Costa committed Apr 29, 2021
1 parent 8a31782 commit 31dbe40
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions glommio/src/executor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -362,8 +362,7 @@ impl ExecutorQueues {
}
}

/// [`LocalExecutor`] factory, which can be used in order to configure the
/// properties of a new [`LocalExecutor`].
/// A factory that can be used to configure and create a [`LocalExecutor`].
///
/// Methods can be chained on it in order to configure it.
///
Expand Down Expand Up @@ -631,10 +630,12 @@ impl CpuSetGenerator {
}
}

/// A factory that allows creating a pool of [`LocalExecutor`]s, which can be
/// used in order to configure the properties of the [`LocalExecutor`]s.
/// Configuration methods apply their settings to all [`LocalExecutor`]s in the
/// pool unless otherwise specified.
/// A factory to configure and create a pool of [`LocalExecutor`]s
///
/// The `LocalExecutorPoolBuilder` allows creating a pool of [`LocalExecutor`]s,
/// which can be used in order to configure the properties of the
/// [`LocalExecutor`]s. Configuration methods apply their settings to all
/// [`LocalExecutor`]s in the pool unless otherwise specified.
///
/// Methods can be chained on the builder in order to configure it.
///
Expand Down

0 comments on commit 31dbe40

Please sign in to comment.