# HG changeset patch
# User Franz Glasner <fzglas.hg@dom66.de>
# Date 1725925950 -7200
# Node ID 38cbc3b70078d212c127abd24b176fb80d281509
# Parent  1e46e254366e3a62d5243a23903c52e943aabccf
Docs: add a return type where appropriate

diff -r 1e46e254366e -r 38cbc3b70078 share/local-bsdtools/common.subr
--- a/share/local-bsdtools/common.subr	Tue Sep 10 01:50:20 2024 +0200
+++ b/share/local-bsdtools/common.subr	Tue Sep 10 01:52:30 2024 +0200
@@ -49,7 +49,7 @@
 #:   $*: The message to print to
 #:
 #: Returns:
-#:   0
+#:   int: 0
 #:
 #: The name of the script is prepended to the error message always.
 #:
@@ -66,7 +66,7 @@
 #:   $*: the fields to display
 #:
 #: Returns:
-#:   0
+#:   int: 0
 #:
 #: The name of the script is prepended to the warning message always.
 #:
@@ -83,7 +83,8 @@
 #:   $1 (str): the name of the variable to test to
 #:
 #: Returns:
-#:   0 (truthy) iff ``yes`` (et al), 1 (falsy) otherwise.
+#:   int: 0 (truthy) iff ``yes`` (et al),
+#:        1 (falsy) otherwise.
 #:
 #: This function warns if other than proper YES/NO values are found.
 #:
@@ -115,7 +116,8 @@
 #:   $1 (str): the name of the variable to test to
 #:
 #: Returns:
-#:   0 (truthy) iff ``yes`` (et al), 1 (falsy) otherwise.
+#:   int: 0 (truthy) iff ``yes`` (et al),
+#:        1 (falsy) otherwise.
 #:
 #: Contrary to `checkyesno` this function does not warn if the variable
 #: contains other values as YES.
@@ -423,9 +425,8 @@
 #:                        followed.
 #:
 #: Returns:
-#:   int
-#:     0 (truish) if it is a valid name,
-#:     1 (falsy) if not.
+#:   int: 0 (truish) if it is a valid name,
+#:        1 (falsy) if not.
 #:
 #: We never check for special pool names (such as ``mirror``, ``raidz``,
 #: ``c0`` to ``c9`` et al.) because we do not create any pools.