docs(scripts): Clarify output

CalConnect · Feb 10, 2025 · 4d2f58a · 4d2f58a
1 parent 3635c6f
commit 4d2f58a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/README.adoc b/README.adoc
@@ -282,7 +282,8 @@ DOC_CLASS=cc \
 ==== link:./scripts/get-all-doc-paths-of-type[`scripts/get-all-doc-paths-of-type`^]
 
 This returns all `.adoc` file paths of a certain `:doctype:` and
-`:mn-document-class:` in a specified directory.
+`:mn-document-class:` in a specified directory,
+as a list of newline-separated paths.
 
 
 ==== link:./scripts/add-all-cc-repos-as-submodules[`scripts/add-all-cc-repos-as-submodules`^]

diff --git a/scripts/get-all-doc-paths-of-type b/scripts/get-all-doc-paths-of-type
@@ -220,8 +220,8 @@ show_usage() {
        $prog_name [-h|--help]
        $prog_name --version
 
-  Get all adoc paths of a certain \e[4m:doctype:\e[24m and \e[4m:mn-document-class:\e[24m in a
-  directory.
+  Return all adoc paths of a certain \e[4m:doctype:\e[24m and \e[4m:mn-document-class:\e[24m
+  in a directory, as a list of newline-separated paths.
 
 \e[4mFlags:\e[24m
   --version   Print the version and exit