format docstrings (still WIP)

This commit is contained in:
steven-omaha
2023-02-23 12:11:45 +01:00
parent 100ee9bef9
commit d064416a37
2 changed files with 6 additions and 5 deletions
+2 -2
View File
@@ -25,8 +25,8 @@ fn main() -> ExitCode {
handle_final_result(main_inner()) handle_final_result(main_inner())
} }
/// Skip printing the error chain when searching packages yields no results, otherwise report error /// Skip printing the error chain when searching packages yields no results,
/// chain. /// otherwise report error chain.
fn handle_final_result(result: Result<()>) -> ExitCode { fn handle_final_result(result: Result<()>) -> ExitCode {
match result { match result {
Ok(_) => ExitCode::SUCCESS, Ok(_) => ExitCode::SUCCESS,
+4 -3
View File
@@ -43,12 +43,13 @@ impl Pacdef {
/// Run the action that was provided by the user as first argument. /// Run the action that was provided by the user as first argument.
/// ///
/// For convenience sake, all called functions take a `&self` argument, even if these are not /// For convenience sake, all called functions take a `&self` argument, even if
/// strictly required. /// these are not strictly required.
/// ///
/// # Panics /// # Panics
/// ///
/// Panics if the user passed an unexpected action. This means all fields from `crate::action::Action` must be matched in this function. /// Panics if the user passed an unexpected action. This means all fields from
/// `crate::action::Action` must be matched in this function.
/// ///
/// # Errors /// # Errors
/// ///