Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update cfg.rs #187

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/cfg.rs
Original file line number Diff line number Diff line change
@@ -21,7 +21,7 @@ pub use circ_opt::clap;
/// Re-export our clap [clap::Args]
pub use circ_opt::CircOpt;

/// A Circ configuration. Contructible [From::from] [CircOpt].
/// A CirC configuration. Constructible [From::from] [CircOpt].
#[derive(Clone, Debug)]
pub struct CircCfg {
opt: CircOpt,
@@ -33,7 +33,7 @@ pub struct CircCfg {
/// If you want to build the CirC configuration [CircCfg] object yourself,
/// you can set it with [set_cfg].
///
/// [CircOpt] implements [clap::Args], so it can be build from your command line or envvars. See
/// [CircOpt] implements [clap::Args], so it can be built from your command line or envvars. See
/// its documentation.
pub fn set(o: &CircOpt) {
set_cfg(From::from(o.clone()))
@@ -47,7 +47,7 @@ pub fn set_default() {

/// Set the CirC configuration from a [CircCfg].
///
/// We recommends using [set], which takes a [CircOpt] instead.
/// We recommend using [set], which takes a [CircOpt] instead.
pub fn set_cfg(c: CircCfg) {
CFG.set(c).unwrap_or_else(|c| {
panic!(
@@ -120,3 +120,4 @@ impl CircCfg {
&self.field
}
}