Skip to content

Commit 6f85c38

Browse files
committed
📚 Expand docstring for namespace
1 parent e78d4aa commit 6f85c38

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

src/lice_comb/maven.clj

+5-6
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
2222
In this namespace abbreviations are used for Maven's groupId, artifactId, and
2323
version concepts. So for example:
24-
* `ga` means groupId & artifactId
25-
* `gav` means groupId, artifactId & version
24+
* `GA` means groupId & artifactId
25+
* `GAV` means groupId, artifactId & version
2626
2727
In function calls where a version isn't required or provided, the library will
2828
determine and use the latest available version, as determined from (in order):
@@ -279,8 +279,7 @@
279279
set)))
280280

281281
(defn gav->expressions-info
282-
"Returns an expressions-info map for the given Maven GA (group-id,
283-
artifact-id) and optionally V (version).
282+
"Returns an expressions-info map for the given GA and (optionally) V.
284283
285284
If version is not provided, the latest version is looked up (which involves
286285
file and potentially also network I/O)."
@@ -292,8 +291,8 @@
292291
(pom->expressions-info pom-is (str pom-uri)))))))
293292

294293
(defn gav->expressions
295-
"Returns a set of SPDX expressions (Strings) for the given Maven GA (group-id,
296-
artifact-id) and optionally V (version).
294+
"Returns a set of SPDX expressions (Strings) for the given GA and optionally
295+
V.
297296
298297
If version is not provided, the latest version is looked up (which involves
299298
file and potentially also network I/O)."

0 commit comments

Comments
 (0)