Document everything with YARD and fix some bugs along the way.

[mailshears.git] / lib / common / exit_codes.rb

diff --git a/lib/common/exit_codes.rb b/lib/common/exit_codes.rb
index b7928a74eb4b7c61733623536a236f676742bf33..a0d030b2648f3c8cdf07e546fc72907868547f03 100644 (file)
--- a/lib/common/exit_codes.rb
+++ b/lib/common/exit_codes.rb
@@ -1,3 +1,5 @@
+# Command-line exit codes. In other words, what you'll see if you
+# <tt>echo $?</tt> after running the executable on the command-line.

 module ExitCodes
   # Everything went better than expected.
   SUCCESS = 0
 module ExitCodes
   # Everything went better than expected.
   SUCCESS = 0