Revision: 722
http://svn.savannah.gnu.org/viewvc/?view=rev&root=administration&revision=722
Author: iank
Date: 2023-12-13 18:32:06 -0500 (Wed, 13 Dec 2023)
Log Message:
-----------
style guide clarity
Modified Paths:
--------------
trunk/sviki/fsf/bash-style-guide.mdwn
Modified: trunk/sviki/fsf/bash-style-guide.mdwn
===================================================================
--- trunk/sviki/fsf/bash-style-guide.mdwn 2023-12-13 22:39:13 UTC (rev
721)
+++ trunk/sviki/fsf/bash-style-guide.mdwn 2023-12-13 23:32:06 UTC (rev
722)
@@ -143,9 +143,7 @@
# Documentation
Add comments describing functions that are not short and
-obvious. Document any arguments, global variables used, return value
-that is different from the default of the exit code of the last command
-run. See the <https://savannah.nongnu.org/git/?group=bash-bear-trap> for
example.
+obvious. Document any arguments, global variables used, and any nonzero
returns. See the <https://savannah.nongnu.org/git/?group=bash-bear-trap> for
example.
Comment any tricky or important parts of code.
