cafkafk/seidr
cafkafk/seidr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: cleaned up comments

Browse source 
Signed-off-by: Christina Sørensen <christina@cafkafk.com>
This commit is contained in:
Christina Sørensen 2023-07-11 16:58:51 +02:00
parent fb691c710b
commit 9d8128d3aa
1 changed files with 4 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/git.rs
View file

@ -426,19 +426,13 @@ impl Config {
/// repos but stop executing further functions on any repo that fails, /// repos but stop executing further functions on any repo that fails,
/// without blocking the repos that don't have an issue. /// without blocking the repos that don't have an issue.
/// ///
/// This is actually somewhat hairy to do, at least at 6:16 am :S
///
/// However, at 6:24, we're so ready! Let's go!
///
/// Fun fact: only the last element of a tuple must have a dynamically typed size
///
/// # Usage /// # Usage
/// ///
/// Here is an example of how an associated method could use this function. /// Here is an example of how an associated method could use this function.
/// ///
/// ``` /// ```
/// use gg::git::SeriesItem; /// # use gg::git::SeriesItem;
/// use gg::git::GitRepo; /// # use gg::git::GitRepo;
/// ///
/// let series: Vec<SeriesItem> = vec![ /// let series: Vec<SeriesItem> = vec![
/// SeriesItem { /// SeriesItem {
@ -458,7 +452,6 @@ impl Config {
/// closure: Box::new(move |repo: &GitRepo| repo.push()), /// closure: Box::new(move |repo: &GitRepo| repo.push()),
/// }, /// },
/// ]; /// ];
/// // e.g. use self.series_on_all(series);
/// ``` /// ```
pub fn series_on_all(&self, closures: Vec<SeriesItem>) { pub fn series_on_all(&self, closures: Vec<SeriesItem>) {
for category in self.categories.values() { for category in self.categories.values() {
@ -491,8 +484,8 @@ impl Config {
/// Here is an example of how an associated method could use this function. /// Here is an example of how an associated method could use this function.
/// ///
/// ``` /// ```
/// use gg::git::GitRepo; /// # use gg::git::GitRepo;
/// use gg::git::SeriesItem; /// # use gg::git::SeriesItem;
/// ///
/// let series: Vec<SeriesItem> = vec![ /// let series: Vec<SeriesItem> = vec![
/// SeriesItem { /// SeriesItem {
@ -512,7 +505,6 @@ impl Config {
/// closure: Box::new(move |repo: &GitRepo| repo.push()), /// closure: Box::new(move |repo: &GitRepo| repo.push()),
/// }, /// },
/// ]; /// ];
/// // self.all_on_all(series);
/// ``` /// ```
pub fn all_on_all(&self, closures: Vec<SeriesItem>) { pub fn all_on_all(&self, closures: Vec<SeriesItem>) {
for category in self.categories.values() { for category in self.categories.values() {