From 504d06eb5fc7cf446194f940aee7b930c98ef976 Mon Sep 17 00:00:00 2001 From: Geoff Shannon Date: Thu, 11 Oct 2018 16:53:39 -0700 Subject: [PATCH 1/2] Add documentation to the file-filter function --- boot/core/src/boot/core.clj | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/boot/core/src/boot/core.clj b/boot/core/src/boot/core.clj index c810a638..f33f8dbe 100644 --- a/boot/core/src/boot/core.clj +++ b/boot/core/src/boot/core.clj @@ -1216,7 +1216,12 @@ #(some identity (seq-pred %)) files)) (defn file-filter - "A file filtering function factory. FIXME: more documenting here." + "A file filtering function factory. This function takes a factory + function which when called with a \"criteria\" returns a predicate + function for testing a java.io.File against that criteria. The + return value is a file filtering function which takes a list of + criteria for matching, files to be filtered and an optional negation + flag to specify whether the predicate should be inverted." [mkpred] (fn [criteria files & [negate?]] (assert (seq criteria) "boot.core/file-filter requires a list of criteria but nil was passed in, make sure your `by-*` calls are passing them.") From ff7336e2b75fbf93892a72435e3afa146f3ef4ad Mon Sep 17 00:00:00 2001 From: Geoff Shannon Date: Thu, 11 Oct 2018 17:05:35 -0700 Subject: [PATCH 2/2] Add documentation for input/output fileset fns --- boot/core/src/boot/core.clj | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/boot/core/src/boot/core.clj b/boot/core/src/boot/core.clj index f33f8dbe..9248cdb5 100644 --- a/boot/core/src/boot/core.clj +++ b/boot/core/src/boot/core.clj @@ -436,7 +436,7 @@ (get-files fileset #{:input})) (defn input-fileset - "FIXME: document" + "Get a fileset tree that contains only files with input role." [fileset] (tmpd/restrict-dirs fileset (input-dirs fileset))) @@ -446,7 +446,7 @@ (get-files fileset #{:output})) (defn output-fileset - "FIXME: document" + "Get a fileset tree that contains only files with output role." [fileset] (tmpd/restrict-dirs fileset (output-dirs fileset)))