diff options
| author | Patrick McDermott <patrick.mcdermott@libiquity.com> | 2019-03-14 00:45:30 (EDT) |
|---|---|---|
| committer | Patrick McDermott <patrick.mcdermott@libiquity.com> | 2019-03-14 00:45:30 (EDT) |
| commit | 5dd5e49129e6979de396ef3267b111fe18c4ba5c (patch) | |
| tree | f692ec49113ff3c76be9914694f1ba3d85ed52d9 /lib | |
| parent | 27a42beaa3cbba77ac904139cf8f55a1437bd01a (diff) | |
ob_error(), ob_warn(), ob_info(): Make @stderr doc cmds more consistent
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/output.sh | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/lib/output.sh b/lib/output.sh index 2d11fe7..dfe4149 100644 --- a/lib/output.sh +++ b/lib/output.sh @@ -25,8 +25,8 @@ ## @operand arguments opt Arguments to be printed, as referenced by ## \fIformat\fP. ## @return Returns 0. -## @stderr This function prints the formatted message, preceded by the program -## name and "Error:", to stderr. +## @stderr Prints the formatted message, preceded by the program name and +## "Error:". ## @pure no This function causes the current shell to exit. ob_error() { @@ -45,8 +45,8 @@ ob_error() ## @operand arguments opt Arguments to be printed, as referenced by ## \fIformat\fP. ## @return Returns 0. -## @stderr This function prints the formatted message, preceded by the program -## name and "Warning:", to stderr. +## @stderr Prints the formatted message, preceded by the program name and +## "Warning:". ## @pure yes This function has no side effects. ob_warn() { @@ -65,8 +65,7 @@ ob_warn() ## @operand arguments opt Arguments to be printed, as referenced by ## \fIformat\fP. ## @return Returns 0. -## @stderr This function prints the formatted message, preceded by the program -## name, to stderr. +## @stderr Prints the formatted message, preceded by the program name. ## @pure yes This function has no side effects. ob_info() { |