Skip to content

Commit

Permalink
docs(libmake): 📝 removed unnecessary comments
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastienrousseau committed Nov 6, 2023
1 parent d19b0c5 commit 04f7c0f
Showing 1 changed file with 3 additions and 12 deletions.
15 changes: 3 additions & 12 deletions src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,15 @@

use clap::{Arg, ArgMatches, Command, Error};

/// Builds and returns a set of command-line arguments using the Clap
/// library.
/// Constructs the CLI for the application using Clap, including all necessary arguments.
///
/// # Arguments
///
/// None
///
/// # Returns
///
/// * `Result<ArgMatches, Error>` - A struct containing the parsed
/// command-line arguments and their values, or an error if the
/// arguments could not be parsed.
/// Returns a `Result` containing the `ArgMatches` if successful, or an `Error` if parsing fails.
///
/// # Examples
///
/// ```
/// use libmake::cli;
/// let matches = cli::build_cli().unwrap();
/// let matches = cli::build_cli().expect("CLI parsing failed");
/// ```
pub fn build_cli() -> Result<ArgMatches, Error> {
let matches = Command::new("My Library")
Expand Down

0 comments on commit 04f7c0f

Please sign in to comment.