History

fix docs (#450)

Sebastian Thiel committed 4 years ago

Commit db46b601 parent de92fce1 file · +4 −4Browse files

Unified · Split

git-credentials/src/helper.rs+4−4
@@ -1,7 +1,7 @@
11 use bstr::{BStr, BString};
22
33 mod error {
4− /// The error used in the [credentials helper][action()].
4+ /// The error used in the [credentials helper][crate::helper()].
55 #[derive(Debug, thiserror::Error)]
66 #[allow(missing_docs)]
77 pub enum Error {
@@ -17,7 +17,7 @@ pub use error::Error; · 9 unmodified lines
1717 /// The Result type used in [`helper()`][crate::helper()].
1818 pub type Result = std::result::Result<Option<Outcome>, Error>;
1919
20−/// The action to perform by the credentials [`action()`].
20+/// The action to perform by the credentials [helper][`crate::helper()`].
2121 #[derive(Clone, Debug)]
2222 pub enum Action<'a> {
2323 /// Provide credentials using the given repository URL (as &str) as context.
@@ -58,11 +58,11 @@ impl NextAction { · 34 unmodified lines
5858 }
5959 }
6060
61−/// The outcome of [`action()`].
61+/// The outcome of the credentials [`helper`][crate::helper()].
6262 pub struct Outcome {
6363 /// The obtained identity.
6464 pub identity: git_sec::identity::Account,
65− /// A handle to the action to perform next using another call to [`action()`].
65+ /// A handle to the action to perform next in another call to [`helper()`][crate::helper()].
6666 pub next: NextAction,
6767 }
6868