From: Eric Huss <eric@huss.org>
Date: Fri, 4 Dec 2020 19:21:16 +0000 (-0800)
Subject: Add docs on how cargo-credential finds the action argument.
X-Git-Url: https://git.proxmox.com/?a=commitdiff_plain;h=37e9c77a33522e873dac36f3670c9969f5e3247f;p=cargo.git

Add docs on how cargo-credential finds the action argument.
---

diff --git a/crates/credential/cargo-credential/src/lib.rs b/crates/credential/cargo-credential/src/lib.rs
index ae30b87d6..43dc0ba31 100644
--- a/crates/credential/cargo-credential/src/lib.rs
+++ b/crates/credential/cargo-credential/src/lib.rs
@@ -8,6 +8,11 @@
 //!     cargo_credential::main(MyCredential);
 //! }
 //! ```
+//!
+//! This will determine the action to perform (get/store/erase) by looking at
+//! the CLI arguments for the first argument that does not start with `-`. It
+//! will then call the corresponding method of the trait to perform the
+//! requested action.
 
 pub type Error = Box<dyn std::error::Error>;