diff options
| author | Lars Wirzenius <liw@liw.fi> | 2021-12-31 09:00:21 +0200 |
|---|---|---|
| committer | Lars Wirzenius <liw@liw.fi> | 2021-12-31 12:10:10 +0200 |
| commit | acf1ba3f8f1492b961c9a6eb09eb93e882f5eb3f (patch) | |
| tree | 1ce0288f878cac71990bb01f358d6035f1626c92 /src/cmd/show_config.rs | |
| parent | 686e87981db210fa443404c8473dfe7a3f39b241 (diff) | |
| download | obnam2-acf1ba3f8f1492b961c9a6eb09eb93e882f5eb3f.tar.gz | |
docs: add documentation comments to crate
Also, make it an error for a public symbol to not be documented.
Sponsored-by: author
Diffstat (limited to 'src/cmd/show_config.rs')
| -rw-r--r-- | src/cmd/show_config.rs | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/src/cmd/show_config.rs b/src/cmd/show_config.rs index 05e83c1..7ac52ec 100644 --- a/src/cmd/show_config.rs +++ b/src/cmd/show_config.rs @@ -1,11 +1,15 @@ +//! The `show-config` subcommand. + use crate::config::ClientConfig; use crate::error::ObnamError; use structopt::StructOpt; +/// Show actual client configuration. #[derive(Debug, StructOpt)] pub struct ShowConfig {} impl ShowConfig { + /// Run the command. pub fn run(&self, config: &ClientConfig) -> Result<(), ObnamError> { println!("{}", serde_json::to_string_pretty(config)?); Ok(()) |