Documented default cmd2 styles.

Author: kmvanbrunt

cmd2/cmd2.py

@@ -292,7 +292,6 @@ class Cmd(cmd.Cmd):
     Line-oriented command interpreters are often useful for test harnesses, internal tools, and rapid prototypes.
     """
 
-    ruler = "─"
     DEFAULT_EDITOR = utils.find_editor()
 
     # Sorting keys for strings
@@ -475,7 +474,10 @@ def __init__(
         # The multiline command currently being typed which is used to tab complete multiline commands.
         self._multiline_in_progress = ''
 
-        # Set text which prints right before all of the help topics are listed.
+        # Characters used to draw a horizontal rule. Should not be blank.
+        self.ruler = "─"
+
+        # Set text which prints right before all of the help tables are listed.
         self.doc_leader = ""
 
         # Set header for table listing documented commands.
@@ -4175,8 +4177,7 @@ def print_topics(self, header: str, cmds: list[str] | None, cmdlen: int, maxcol:
 
         header_grid = Table.grid()
         header_grid.add_row(header, style=Cmd2Style.HELP_HEADER)
-        if self.ruler:
-            header_grid.add_row(Rule(characters=self.ruler))
+        header_grid.add_row(Rule(characters=self.ruler))
         self.poutput(header_grid)
         self.columnize(cmds, maxcol - 1)
         self.poutput()

cmd2/styles.py

@@ -30,13 +30,13 @@ class Cmd2Style(StrEnum):
     added here must have a corresponding style definition there.
     """
 
-    ERROR = "cmd2.error"
-    EXAMPLE = "cmd2.example"
-    HELP_HEADER = "cmd2.help.header"
-    HELP_LEADER = "cmd2.help.leader"
-    RULE_LINE = "cmd2.rule.line"
-    SUCCESS = "cmd2.success"
-    WARNING = "cmd2.warning"
+    ERROR = "cmd2.error"  # Error text (used by perror())
+    EXAMPLE = "cmd2.example"  # Command line examples in help text
+    HELP_HEADER = "cmd2.help.header"  # Help table header text
+    HELP_LEADER = "cmd2.help.leader"  # Text right before the help tables are listed
+    RULE_LINE = "rule.line"  # Rich style for horizontal rules
+    SUCCESS = "cmd2.success"  # Success text (used by psuccess())
+    WARNING = "cmd2.warning"  # Warning text (used by pwarning())
 
 
 # Default styles used by cmd2. Tightly coupled with the Cmd2Style enum.