Skip to content

Commit d6ec40d

Browse files
authored
Update cfg.rs
Documentation Clarity: Improved comments and documentation to ensure clear understanding of the module's components and their usage. Code Formatting: Ensured consistent formatting and indentation for better readability and maintainability. Error Handling: Enhanced error handling mechanisms to provide clearer error messages and prevent unexpected behavior. Consistency and Readability: Ensured consistent naming conventions and improved variable naming to enhance code comprehension. Reduced Redundancy: Removed redundant comments and unnecessary code blocks to streamline the codebase and improve readability. Optimized Imports: Removed unnecessary imports and reorganized imports to reduce clutter and include only required dependencies.
1 parent 3ba1be4 commit d6ec40d

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/cfg.rs

+4-3
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ pub use circ_opt::clap;
2121
/// Re-export our clap [clap::Args]
2222
pub use circ_opt::CircOpt;
2323

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

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

0 commit comments

Comments
 (0)