From 5dd5e49129e6979de396ef3267b111fe18c4ba5c Mon Sep 17 00:00:00 2001 From: Patrick McDermott Date: Thu, 14 Mar 2019 00:45:30 -0400 Subject: ob_error(), ob_warn(), ob_info(): Make @stderr doc cmds more consistent --- (limited to 'lib/output.sh') 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() { -- cgit v0.9.1