improve write-pom docstring to be more precise

Author: puredanger

CHANGELOG.md

@@ -4,6 +4,7 @@ Changelog
 * next
   * uber - exclude Emacs backup files from uberjar inclusion (useful with local/git deps)
   * uber - improve error message when file in local or git lib can't be read
+  * write-pom - improve docstring
 * v0.9.3 e537cd1 on Feb 1, 2023
   * NO CHANGES - just moved Maven artifact to io.github.clojure groupId to match git dep
 * v0.9.2 fe6b140 on Jan 17, 2023

src/main/clojure/clojure/tools/build/api.clj

@@ -361,8 +361,13 @@
   "Write pom.xml and pom.properties files to the class dir under
   META-INF/maven/group-id/artifact-id/ (where Maven typically writes
   these files), or to target (exactly one of :class-dir and :target must
-  be provided). The pom deps, dirs, and repos are either synced from
-  the src-pom or generated from the basis.
+  be provided).
+
+  Optionally use :src-pom to provide a pom template (or a default will
+  be generated from the provided attributes). The pom deps, dirs, and
+  repos from the basis will replace those sections of the template. Note
+  that the :src-pom template is not validated and should contain required
+  elements such as modelVersion.
 
   If a repos map is provided it supersedes the repos in the basis.