aboutsummaryrefslogtreecommitdiffstats
path: root/src/suggestion.rs
diff options
context:
space:
mode:
authorTeddy Wing2020-08-02 18:49:36 +0200
committerTeddy Wing2020-08-02 18:49:51 +0200
commit8e5ac6f2d4e52eea95e5a6fc2905ce511ac4956e (patch)
treef5e56fbf1fc673c8a75f160c297fa79d0937e0d4 /src/suggestion.rs
parent646ed6c2027864b6373453c2f529796f01b3e715 (diff)
downloadgit-suggestion-8e5ac6f2d4e52eea95e5a6fc2905ce511ac4956e.tar.bz2
Add documentation comments
Light documentation for our various functions and types.
Diffstat (limited to 'src/suggestion.rs')
-rw-r--r--src/suggestion.rs2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/suggestion.rs b/src/suggestion.rs
index fc22a7c..9f23a0d 100644
--- a/src/suggestion.rs
+++ b/src/suggestion.rs
@@ -9,6 +9,8 @@ use crate::arg::is_suggestion_id;
use crate::config::Config;
+/// For all suggestions in `config.suggestions`, fetch the suggestion from the
+/// API and call `f` with it.
pub fn for_suggestion<F>(config: &Config, f: F)
where F: Fn(&Suggestion)
{