📚 Expand docstring for namespace

Author: pmonks

src/lice_comb/maven.clj

@@ -19,18 +19,18 @@
 (ns lice-comb.maven
   "Functionality related to combing Maven POMs for license information.
 
-In this namespace abbreviations are used for Maven's groupId, artifactId, and
-version concepts.  So for example:
-* `ga` means groupId & artifactId
-* `gav` means groupId, artifactId & version
-
-In function calls where a version isn't required or provided, the library will
-determine and use the latest available version, as determined from (in order):
-1. your local Maven cache (usually ~/.m2/repository)
-2. Maven Central
-3. Clojars
-
-Other/custom Maven artifact repositories are not currently supported."
+  In this namespace abbreviations are used for Maven's groupId, artifactId, and
+  version concepts.  So for example:
+  * `ga` means groupId & artifactId
+  * `gav` means groupId, artifactId & version
+  
+  In function calls where a version isn't required or provided, the library will
+  determine and use the latest available version, as determined from (in order):
+  1. your local Maven cache (usually ~/.m2/repository)
+  2. Maven Central
+  3. Clojars
+  
+  Other/custom Maven artifact repositories are not currently supported."
   (:require [clojure.string                  :as s]
             [clojure.java.io                 :as io]
             [clojure.java.shell              :as sh]
@@ -138,7 +138,9 @@ Other/custom Maven artifact repositories are not currently supported."
 
 (defn ga-latest-version
   "Determines the latest version of the given GA as a String, or nil if it
-  cannot be determined."
+  cannot be determined.
+
+  Note that this could be a SNAPSHOT, RC, or other pre-release version."
   [group-id artifact-id]
   (when-let [metadata-uri (ga->metadata-uri group-id artifact-id)]
     (with-open [metadata-is (io/input-stream metadata-uri)]
@@ -149,7 +151,7 @@ Other/custom Maven artifact repositories are not currently supported."
 
 (defn ga-release-version
   "Determines the release version (if any) of the given GA as a String, or nil
-  if it cannot be determined."
+  if it cannot be determined or the GA doesn't have a released version yet."
   [group-id artifact-id]
   (when-let [metadata-uri (ga->metadata-uri group-id artifact-id)]
     (with-open [metadata-is (io/input-stream metadata-uri)]