docstrings and made read-edn public

Author: puredanger

src/main/clojure/clojure/tools/deps/edn.clj

@@ -43,7 +43,7 @@
   (let [abs-path (.getAbsolutePath (jio/file path))]
     (ex-info (format fmt abs-path) {:path abs-path})))
 
-(defn- read-edn
+(defn read-edn
   "Read edn from Reader r, which should contain exactly one edn value.
   If source exists but is blank, nil is returned.
   Throws if source is unreadable or contains multiple values.
@@ -173,7 +173,10 @@
   (str dir/*the-dir* File/separator "deps.edn"))
 
 (defn project-deps
-  "Calculate the project deps.edn location "
+  "Calculate the project deps.edn location, read and return the deps.edn data.
+
+  You may use clojure.tools.deps.util.dir/with-dir to read from a custom project
+  dir, either absolute or relative to the current dir context."
   []
   (-> (project-deps-path) jio/file dir/canonicalize read-deps))
 
@@ -190,7 +193,7 @@
   "Takes optional map of location sources, keys = :root :user :project :extra
   where each key may be:
     :standard (default) - to get the default source
-    string - for file path to source
+    string - for file path to source, relative to current dir context
     nil - to omit
     map - a literal map to use