Autodoc commit for master/56ecd5f3

Author: tomfaulhaber

index-0.3.2.clj

@@ -1,6 +1,6 @@
 {:namespaces
  ({:source-url
-   "https://github.com/clojure/tools.cli/blob/b2ffe90b00e299dbcbaeb0c903409d50e64cbcd9/src/main/clojure/clojure/tools/cli.clj",
+   "https://github.com/clojure/tools.cli/blob/56ecd5f305d444bbf6dcd28f4f4adce58ebc0de4/src/main/clojure/clojure/tools/cli.clj",
    :wiki-url
    "http://clojure.github.com/tools.cli/clojure.tools.cli-api.html",
    :name "clojure.tools.cli",
@@ -11,43 +11,43 @@
    :name "cli",
    :namespace "clojure.tools.cli",
    :source-url
-   "https://github.com/clojure/tools.cli/blob/b2ffe90b00e299dbcbaeb0c903409d50e64cbcd9/src/main/clojure/clojure/tools/cli.clj#L180",
+   "https://github.com/clojure/tools.cli/blob/56ecd5f305d444bbf6dcd28f4f4adce58ebc0de4/src/main/clojure/clojure/tools/cli.clj#L179",
    :raw-source-url
-   "https://github.com/clojure/tools.cli/raw/b2ffe90b00e299dbcbaeb0c903409d50e64cbcd9/src/main/clojure/clojure/tools/cli.clj",
+   "https://github.com/clojure/tools.cli/raw/56ecd5f305d444bbf6dcd28f4f4adce58ebc0de4/src/main/clojure/clojure/tools/cli.clj",
    :wiki-url
    "http://clojure.github.com/tools.cli//clojure.tools.cli-api.html#clojure.tools.cli/cli",
    :doc
    "THIS IS A LEGACY FUNCTION and may be deprecated in the future. Please use\nclojure.tools.cli/parse-opts in new applications.\n\nParse the provided args using the given specs. Specs are vectors\ndescribing a command line argument. For example:\n\n[\"-p\" \"--port\" \"Port to listen on\" :default 3000 :parse-fn #(Integer/parseInt %)]\n\nFirst provide the switches (from least to most specific), then a doc\nstring, and pairs of options.\n\nValid options are :default, :parse-fn, and :flag. See\nhttps://github.com/clojure/tools.cli/wiki/Documentation-for-0.2.4 for more\ndetailed examples.\n\nReturns a vector containing a map of the parsed arguments, a vector\nof extra arguments that did not match known switches, and a\ndocumentation banner to provide usage instructions.",
    :var-type "function",
-   :line 180,
+   :line 179,
    :file "src/main/clojure/clojure/tools/cli.clj"}
   {:arglists ([args option-specs & options]),
    :name "parse-opts",
    :namespace "clojure.tools.cli",
    :source-url
-   "https://github.com/clojure/tools.cli/blob/b2ffe90b00e299dbcbaeb0c903409d50e64cbcd9/src/main/clojure/clojure/tools/cli.clj#L389",
+   "https://github.com/clojure/tools.cli/blob/56ecd5f305d444bbf6dcd28f4f4adce58ebc0de4/src/main/clojure/clojure/tools/cli.clj#L419",
    :added "0.3.0",
    :raw-source-url
-   "https://github.com/clojure/tools.cli/raw/b2ffe90b00e299dbcbaeb0c903409d50e64cbcd9/src/main/clojure/clojure/tools/cli.clj",
+   "https://github.com/clojure/tools.cli/raw/56ecd5f305d444bbf6dcd28f4f4adce58ebc0de4/src/main/clojure/clojure/tools/cli.clj",
    :wiki-url
    "http://clojure.github.com/tools.cli//clojure.tools.cli-api.html#clojure.tools.cli/parse-opts",
    :doc
-   "Parse arguments sequence according to given option specifications and the\nGNU Program Argument Syntax Conventions:\n\n  https://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html\n\nOption specifications are a sequence of vectors with the following format:\n\n  [short-opt long-opt-with-required-description description\n   :property value]\n\nThe first three string parameters in an option spec are positional and\noptional, and may be nil in order to specify a later parameter.\n\nBy default, options are boolean flags that are set to true when toggled, but\nthe second string parameter may be used to specify that an option requires\nan argument.\n\n  e.g. [\"-p\" \"--port PORT\"] specifies that --port requires an argument,\n       of which PORT is a short description.\n\nThe :property value pairs are optional and take precedence over the\npositional string arguments. The valid properties are:\n\n  :id           The key for this option in the resulting option map. This\n                is normally set to the keywordized name of the long option\n                without the leading dashes.\n\n                Must be a unique truthy value.\n\n  :short-opt    The short format for this option, normally set by the first\n                positional string parameter: e.g. \"-p\". Must be unique.\n\n  :long-opt     The long format for this option, normally set by the second\n                positional string parameter; e.g. \"--port\". Must be unique.\n\n  :required     A description of the required argument for this option if\n                one is required; normally set in the second positional\n                string parameter after the long option: \"--port PORT\".\n\n                The absence of this entry indicates that the option is a\n                boolean toggle that is set to true when specified on the\n                command line.\n\n  :desc         A optional short description of this option.\n\n  :default      The default value of this option. If none is specified, the\n                resulting option map will not contain an entry for this\n                option unless set on the command line.\n\n  :default-desc An optional description of the default value. This should be\n                used when the string representation of the default value is\n                too ugly to be printed on the command line.\n\n  :parse-fn     A function that receives the required option argument and\n                returns the option value.\n\n                If this is a boolean option, parse-fn will receive the value\n                true. This may be used to invert the logic of this option:\n\n                [\"-q\" \"--quiet\"\n                 :id :verbose\n                 :default true\n                 :parse-fn not]\n\n  :assoc-fn     A function that receives the current option map, the current\n                option :id, and the current parsed option value, and returns\n                a new option map.\n\n                This may be used to create non-idempotent options, like\n                setting a verbosity level by specifying an option multiple\n                times. (\"-vvv\" -> 3)\n\n                [\"-v\" \"--verbose\"\n                 :default 0\n                 :assoc-fn (fn [m k _] (update-in m [k] inc))]\n\n  :validate     A vector of [validate-fn validate-msg].\n\n  :validate-fn  A function that receives the parsed option value and returns\n                a falsy value when the value is invalid.\n\n  :validate-msg An optional message that will be added to the :errors vector\n                on validation failure.\n\nparse-opts returns a map with four entries:\n\n  {:options     The options map, keyed by :id, mapped to the parsed value\n   :arguments   A vector of unprocessed arguments\n   :summary     A string containing a minimal options summary\n   :errors      A possible vector of error message strings generated during\n                parsing; nil when no errors exist\n   }\n\nA few function options may be specified to influence the behavior of\nparse-opts:\n\n  :in-order     Stop option processing at the first unknown argument. Useful\n                for building programs with subcommands that have their own\n                option specs.\n\n  :summary-fn   A function that receives the sequence of compiled option specs\n                (documented at #'clojure.tools.cli/compile-option-specs), and\n                returns a custom option summary string.\n",
+   "Parse arguments sequence according to given option specifications and the\nGNU Program Argument Syntax Conventions:\n\n  https://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html\n\nOption specifications are a sequence of vectors with the following format:\n\n  [short-opt long-opt-with-required-description description\n   :property value]\n\nThe first three string parameters in an option spec are positional and\noptional, and may be nil in order to specify a later parameter.\n\nBy default, options are boolean flags that are set to true when toggled, but\nthe second string parameter may be used to specify that an option requires\nan argument.\n\n  e.g. [\"-p\" \"--port PORT\"] specifies that --port requires an argument,\n       of which PORT is a short description.\n\nThe :property value pairs are optional and take precedence over the\npositional string arguments. The valid properties are:\n\n  :id           The key for this option in the resulting option map. This\n                is normally set to the keywordized name of the long option\n                without the leading dashes.\n\n                Must be a unique truthy value.\n\n  :short-opt    The short format for this option, normally set by the first\n                positional string parameter: e.g. \"-p\". Must be unique.\n\n  :long-opt     The long format for this option, normally set by the second\n                positional string parameter; e.g. \"--port\". Must be unique.\n\n  :required     A description of the required argument for this option if\n                one is required; normally set in the second positional\n                string parameter after the long option: \"--port PORT\".\n\n                The absence of this entry indicates that the option is a\n                boolean toggle that is set to true when specified on the\n                command line.\n\n  :desc         A optional short description of this option.\n\n  :default      The default value of this option. If none is specified, the\n                resulting option map will not contain an entry for this\n                option unless set on the command line.\n\n  :default-desc An optional description of the default value. This should be\n                used when the string representation of the default value is\n                too ugly to be printed on the command line.\n\n  :parse-fn     A function that receives the required option argument and\n                returns the option value.\n\n                If this is a boolean option, parse-fn will receive the value\n                true. This may be used to invert the logic of this option:\n\n                [\"-q\" \"--quiet\"\n                 :id :verbose\n                 :default true\n                 :parse-fn not]\n\n  :assoc-fn     A function that receives the current option map, the current\n                option :id, and the current parsed option value, and returns\n                a new option map.\n\n                This may be used to create non-idempotent options, like\n                setting a verbosity level by specifying an option multiple\n                times. (\"-vvv\" -> 3)\n\n                [\"-v\" \"--verbose\"\n                 :default 0\n                 :assoc-fn (fn [m k _] (update-in m [k] inc))]\n\n  :validate     A vector of [validate-fn validate-msg ...]. Multiple pairs\n                of validation functions and error messages may be provided.\n\n  :validate-fn  A vector of functions that receives the parsed option value\n                and returns a falsy value or throws an exception when the\n                value is invalid. The validations are tried in the given\n                order.\n\n  :validate-msg A vector of error messages corresponding to :validate-fn\n                that will be added to the :errors vector on validation\n                failure.\n\nparse-opts returns a map with four entries:\n\n  {:options     The options map, keyed by :id, mapped to the parsed value\n   :arguments   A vector of unprocessed arguments\n   :summary     A string containing a minimal options summary\n   :errors      A possible vector of error message strings generated during\n                parsing; nil when no errors exist}\n\nA few function options may be specified to influence the behavior of\nparse-opts:\n\n  :in-order     Stop option processing at the first unknown argument. Useful\n                for building programs with subcommands that have their own\n                option specs.\n\n  :summary-fn   A function that receives the sequence of compiled option specs\n                (documented at #'clojure.tools.cli/compile-option-specs), and\n                returns a custom option summary string.\n",
    :var-type "function",
-   :line 389,
+   :line 419,
    :file "src/main/clojure/clojure/tools/cli.clj"}
   {:arglists ([specs]),
    :name "summarize",
    :namespace "clojure.tools.cli",
    :source-url
-   "https://github.com/clojure/tools.cli/blob/b2ffe90b00e299dbcbaeb0c903409d50e64cbcd9/src/main/clojure/clojure/tools/cli.clj#L370",
+   "https://github.com/clojure/tools.cli/blob/56ecd5f305d444bbf6dcd28f4f4adce58ebc0de4/src/main/clojure/clojure/tools/cli.clj#L400",
    :added "0.3.0",
    :raw-source-url
-   "https://github.com/clojure/tools.cli/raw/b2ffe90b00e299dbcbaeb0c903409d50e64cbcd9/src/main/clojure/clojure/tools/cli.clj",
+   "https://github.com/clojure/tools.cli/raw/56ecd5f305d444bbf6dcd28f4f4adce58ebc0de4/src/main/clojure/clojure/tools/cli.clj",
    :wiki-url
    "http://clojure.github.com/tools.cli//clojure.tools.cli-api.html#clojure.tools.cli/summarize",
    :doc
    "Reduce options specs into a options summary for printing at a terminal.",
    :var-type "function",
-   :line 370,
+   :line 400,
    :file "src/main/clojure/clojure/tools/cli.clj"})}

index.html

@@ -111,7 +111,7 @@ <h2 id="clojure.tools.cli/cli">cli</h2>
 documentation banner to provide usage instructions.</pre>
 
 
-    <a href="https://github.com/clojure/tools.cli/blob/b2ffe90b00e299dbcbaeb0c903409d50e64cbcd9/src/main/clojure/clojure/tools/cli.clj#L180" id="var-source">Source</a>
+    <a href="https://github.com/clojure/tools.cli/blob/56ecd5f305d444bbf6dcd28f4f4adce58ebc0de4/src/main/clojure/clojure/tools/cli.clj#L179" id="var-source">Source</a>
   </div><div id="var-entry">
     <br />
     <hr />
@@ -195,22 +195,25 @@ <h2 id="clojure.tools.cli/parse-opts">parse-opts</h2>
                  :default 0
                  :assoc-fn (fn [m k _] (update-in m [k] inc))]
 
-  :validate     A vector of [validate-fn validate-msg].
+  :validate     A vector of [validate-fn validate-msg ...]. Multiple pairs
+                of validation functions and error messages may be provided.
 
-  :validate-fn  A function that receives the parsed option value and returns
-                a falsy value when the value is invalid.
+  :validate-fn  A vector of functions that receives the parsed option value
+                and returns a falsy value or throws an exception when the
+                value is invalid. The validations are tried in the given
+                order.
 
-  :validate-msg An optional message that will be added to the :errors vector
-                on validation failure.
+  :validate-msg A vector of error messages corresponding to :validate-fn
+                that will be added to the :errors vector on validation
+                failure.
 
 parse-opts returns a map with four entries:
 
   {:options     The options map, keyed by :id, mapped to the parsed value
    :arguments   A vector of unprocessed arguments
    :summary     A string containing a minimal options summary
    :errors      A possible vector of error message strings generated during
-                parsing; nil when no errors exist
-   }
+                parsing; nil when no errors exist}
 
 A few function options may be specified to influence the behavior of
 parse-opts:
@@ -225,7 +228,7 @@ <h2 id="clojure.tools.cli/parse-opts">parse-opts</h2>
 </pre>
     <span class="var-added"><span id="content">Added in Command-line processor version 0.3.0</span><br /></span>
 
-    <a href="https://github.com/clojure/tools.cli/blob/b2ffe90b00e299dbcbaeb0c903409d50e64cbcd9/src/main/clojure/clojure/tools/cli.clj#L389" id="var-source">Source</a>
+    <a href="https://github.com/clojure/tools.cli/blob/56ecd5f305d444bbf6dcd28f4f4adce58ebc0de4/src/main/clojure/clojure/tools/cli.clj#L419" id="var-source">Source</a>
   </div><div id="var-entry">
     <br />
     <hr />
@@ -236,7 +239,7 @@ <h2 id="clojure.tools.cli/summarize">summarize</h2>
     <pre id="var-docstr">Reduce options specs into a options summary for printing at a terminal.</pre>
     <span class="var-added"><span id="content">Added in Command-line processor version 0.3.0</span><br /></span>
 
-    <a href="https://github.com/clojure/tools.cli/blob/b2ffe90b00e299dbcbaeb0c903409d50e64cbcd9/src/main/clojure/clojure/tools/cli.clj#L370" id="var-source">Source</a>
+    <a href="https://github.com/clojure/tools.cli/blob/56ecd5f305d444bbf6dcd28f4f4adce58ebc0de4/src/main/clojure/clojure/tools/cli.clj#L400" id="var-source">Source</a>
   </div>
 </div>