# HG changeset patch
# User Franz Glasner <fzglas.hg@dom66.de>
# Date 1727440597 -7200
# Node ID b8b07ff189f6d6cf9f2cb63ee0707adad9449014
# Parent  4dded1830266d5171624a6660631e084db686fd4
common.subr: Enhance docs

diff -r 4dded1830266 -r b8b07ff189f6 share/local-bsdtools/common.subr
--- a/share/local-bsdtools/common.subr	Fri Sep 27 13:22:11 2024 +0200
+++ b/share/local-bsdtools/common.subr	Fri Sep 27 14:36:37 2024 +0200
@@ -426,7 +426,11 @@
 #: The output is sorted by the mountpoint.
 #:
 #: Args:
-#:   $1: the directory where to start for mounts and sub-mounts
+#:   $1 (str, optional): The directory where to start for mounts and sub-mounts.
+#:       It must be an absolute path and may not have a trailing slash ``/``.
+#:       The root directory :file:`/` is allowed.
+#:       A `null` value is treated as if the root directory :file:`/`
+#:       is given as argument.
 #:
 #: Other Parameters:
 #:   -r (optional): If given the the output is sorted in reverse order.