More docs for modules

ask/ask.go

 /*
 Package ask provides routines to ask questions of users. It handles
-getting a line of text, getting a choice from a liat and other things.
+getting a line of text, getting a choice from a list and other things.
+
+Underneath it uses the [github.com/chzyer/readline] module.
 */
 package ask
 

batch/batch.go

-// Package batch contains the non-interactive maintenence commands.
+// Package batch contains both interactive and non-interactive maintenence
+// commands.
+//
+// The interactive batch commands are as follows:
+//
+//   - `install` does the initial install for bulletin.  This will create
+//     and seed the database and create the initial user.  It will also
+//     create the user's crontab entries.
+//   - `new-user` creates a new user.
+//
+// The non-interactive batch commands are run from the user's crontab.
+//
+//   - `reboot` is supposed to be run on system reboot and will delete
+//     all shutdown messages.
+//   - `expire` removes all expired messages and deletes broadcast messages
+//     older than 3 days.
 package batch
 
 import (

dclish/dclish.go

-// Package dclish A DCL-like command line parser.
+/*
+Package dclish A DCL-like command line parser.
+
+From the OpenVMS manual on how to parse a DCL command line.
+
+The following rules apply when entering DCL commands. Refer to
+Chapter 5 for information about using extended file names in DCL
+commands.
+
+  - Use any combination of uppercase and lowercase letters. The DCL
+    interpreter translates lowercase letters to uppercase. Uppercase and
+    lowercase characters in parameter and qualifier values are equivalent
+    unless enclosed in quotation marks (" ").
+  - Separate the command name from the first parameter with at least one
+    blank space or a tab.
+  - Separate each additional parameter from the previous parameter or
+    qualifier with at least one blank space or a tab.
+  - Begin each qualifier with a slash (/). The slash serves as a separator
+    and need not be preceded by blank spaces or tabs.
+  - If a parameter or qualifier value includes a blank space or a tab,
+    enclose the parameter or qualifier value in quotation marks.
+  - You cannot specify null characters (<NUL>) on a DCL command line,
+    even if you enclose the null character in quotation marks.
+  - Include no more than 127 elements (parameters, qualifiers, and qualifier
+    values) in each command line.
+  - Each element in a command must not exceed 255 characters. The entire
+    command must not exceed 1024 characters after all symbols1 and lexical
+    functions2 are converted to their values.
+  - You can abbreviate a command as long as the abbreviated name remains
+    unique among the defined commands on a system. DCL looks only at the
+    first four characters for uniqueness.
+*/
 package dclish
 
 import (