From 28e45494bf270cc93cea4af52eacac884a06419c Mon Sep 17 00:00:00 2001 From: clojure-build Date: Thu, 21 Nov 2024 21:09:02 +0000 Subject: [PATCH] Autodoc commit --- api-index.html | 12 +++--- index.html | 102 +++++++++++++++++++++++++++++++++---------------- 2 files changed, 77 insertions(+), 37 deletions(-) diff --git a/api-index.html b/api-index.html index 98a1f3b..b496c29 100644 --- a/api-index.html +++ b/api-index.html @@ -1,7 +1,7 @@ - Index - tools.deps 0.18.1355-SNAPSHOT API documentation + Index - tools.deps 0.21.1457-SNAPSHOT API documentation @@ -25,7 +25,7 @@

tools.deps A
- tools.deps 0.18.1355-SNAPSHOT API
+ tools.deps 0.21.1457-SNAPSHOT API
  • Overview
  • API Index
    • @@ -41,7 +41,7 @@

    tools.deps A
    -

    Index of Public Functions and Variables - tools.deps 0.18.1355-SNAPSHOT (in development)

    +

    Index of Public Functions and Variables - tools.deps 0.21.1457-SNAPSHOT (in development)

    This page has an alphabetical index of all the documented functions and variables in tools.deps. @@ -99,13 +99,14 @@

    D

    ::default-deps spec clojure.tools.deps.specs (map-of :clojure.tools.deps.specs/lib :cloju... ::dependents spec clojure.tools.deps.specs (coll-of :clojure.tools.deps.specs/lib). ::deps spec clojure.tools.deps.specs (map-of :clojure.tools.deps.specs/lib :cloju... - ::deps-map spec clojure.tools.deps.specs (keys :opt [:mvn/repos :mvn/local-repo :tool... + ::deps-map spec clojure.tools.deps.specs (nilable (keys :opt-un [:clojure.tools.deps....

    E

      ::exec-args                  spec          clojure.tools.deps.specs (nilable map?).
+ explain-deps                 function      clojure.tools.deps.specs If a spec is invalid, return a message expla...
  ::extra-deps                 spec          clojure.tools.deps.specs (map-of :clojure.tools.deps.specs/lib :cloju...
  ::extra-paths                spec          clojure.tools.deps.specs (coll-of :clojure.tools.deps.specs/path-ref ...
 
@@ -233,7 +234,8 @@ 
    U

    V

    -
+ valid-deps?                  function      clojure.tools.deps.specs Determine whether the deps map is valid acco...
+

    W

    diff --git a/index.html b/index.html index b4ed173..4f83d23 100644 --- a/index.html +++ b/index.html @@ -1,7 +1,7 @@ - clojure.tools.deps - tools.deps 0.18.1355-SNAPSHOT API documentation + clojure.tools.deps - tools.deps 0.21.1457-SNAPSHOT API documentation @@ -25,7 +25,7 @@

    tools.deps A
    - tools.deps 0.18.1355-SNAPSHOT API
    + tools.deps 0.21.1457-SNAPSHOT API
    clojure.tools.deps.specs
    + explain-deps + +
    + valid-deps? + +
    ::alias
    @@ -244,7 +250,7 @@

    Table of Contents

    API for clojure.tools.deps - - tools.deps 0.18.1355-SNAPSHOT (in development) + - tools.deps 0.21.1457-SNAPSHOT (in development)


    Full namespace name: clojure.tools.deps @@ -291,7 +297,7 @@

    calc-basis

    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -304,13 +310,13 @@ 
    combine-aliases
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
     
    create-basis
    
     function
    
-    
    Usage: (create-basis {:keys [root user project extra aliases], :as params})
+    
    Usage: (create-basis {:keys [dir root user project extra aliases], :as params})
 
    
     
    Create a basis from a set of deps sources and a set of aliases. By default, use
 root, user, and project deps and no argmaps (essentially the same classpath you get by
@@ -323,9 +329,10 @@ 
    create-basis
    
 subprocesses (tool, resolve-deps, make-classpath-map).
 
 Options:
+  :dir     - directory root path, defaults to current directory
   :root    - dep source, default = :standard
   :user    - dep source, default = :standard
-  :project - dep source, default = :standard ("./deps.edn")
+  :project - dep source, default = :standard ("deps.edn")
   :extra   - dep source, default = nil
   :aliases - coll of aliases, default = nil
 
@@ -348,7 +355,7 @@ 
    create-basis
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -361,7 +368,7 @@ 
    create-edn-maps
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -376,7 +383,7 @@ 
    find-edn-maps
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -390,7 +397,7 @@ 
    find-latest-version
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -402,7 +409,7 @@ 
    join-classpath
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -415,7 +422,7 @@ 
    lib-location
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -440,7 +447,7 @@ 
    make-classpath
    
   Ret:  string?
     
     Deprecated since tools.deps version 0.9.745
    
-    Source
+    Source
   
    
     
    
     
    
@@ -461,11 +468,11 @@ 
    make-classpath-map
    
   Args: (cat
          :deps :clojure.tools.deps.specs/deps-map
          :libs :clojure.tools.deps.specs/lib-map
-         :classpath-args :clojure.tools.deps.specs/claspath-args)
+         :classpath-args :clojure.tools.deps.specs/classpath-args)
   Ret:  map?
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -477,7 +484,7 @@ 
    merge-edns
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -499,7 +506,7 @@ 
    prep-libs!
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -511,7 +518,7 @@ 
    print-tree
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -535,7 +542,7 @@ 
    resolve-added-libs
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -563,7 +570,7 @@ 
    resolve-deps
    
           :clojure.tools.deps.specs/resolved-coord)
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -576,7 +583,7 @@ 
    root-deps
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -589,7 +596,7 @@ 
    slurp-deps
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -602,7 +609,7 @@ 
    tool
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -615,7 +622,7 @@ 
    user-deps-path
    
     
    
     
     
-    Source
+    Source
   
    
 
    
 
@@ -627,7 +634,36 @@ 
    clojure.tools.deps.specs
    
 
    
 
 
-
+
    
+  
    
+  
    Public Variables and Functions
    
+  
    
+    
    
+    
    
+    
    explain-deps
    
+    function
    
+    
    Usage: (explain-deps deps-map)
+
    
+    
    If a spec is invalid, return a message explaining why, suitable
+for an error message
    
+    
    
+    
+    
+    Source
+  
    
+    
    
+    
    
+    
    valid-deps?
    
+    function
    
+    
    Usage: (valid-deps? deps-map)
+
    
+    
    Determine whether the deps map is valid according to the specs
    
+    
    
+    
+    
+    Source
+  
    
+
    
 
    
   
    
   
    Specs
    
@@ -690,9 +726,10 @@ 
    ::deps
    
     
    
     
    ::deps-map
    
     spec
    
-    
    (keys
- :opt [:mvn/repos :mvn/local-repo :tools/usage :deps/prep-lib]
- :opt-un [::paths ::deps ::aliases])
    
+    
    (nilable
+  (keys
+   :opt-un [::paths ::deps ::aliases]
+   :opt [:mvn/repos :mvn/local-repo :tools/usage :deps/prep-lib]))
    
   
    
     
    
     
    
@@ -932,6 +969,7 @@ 
    calc-trace
    
 subprocesses (tool, resolve-deps, make-classpath-map).
 
 Options:
+  :dir     - directory root path, defaults to current directory
   :root    - dep source, default = :standard
   :user    - dep source, default = :standard
   :project - dep source, default = :standard ("./deps.edn")
@@ -940,7 +978,7 @@ 
    calc-trace
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -956,7 +994,7 @@ 
    print-tree
    
     
    
     
     
-    Source
+    Source
   
    
     
    
     
    
@@ -977,7 +1015,7 @@ 
    trace->tree
    
     
    
     
     
-    Source
+    Source