changeset 6191:5713ddd87fd3

Fix help text. First steps at normalizing the formatting of help text for use by the method help_commands_html. It needs a specific format for lines to propelry annotate with html markup. I hope to use this method to keep doc pages up to date as the current manual doc pages are out of date.
author John Rouillard <rouilj@ieee.org>
date Mon, 08 Jun 2020 16:21:38 -0400
parents 15fd91fd3c4c
children 38d04127d9bb
files roundup/admin.py
diffstat 1 files changed, 17 insertions(+), 14 deletions(-) [+]
line wrap: on
line diff
--- a/roundup/admin.py	Mon Jun 08 16:18:21 2020 -0400
+++ b/roundup/admin.py	Mon Jun 08 16:21:38 2020 -0400
@@ -503,8 +503,8 @@
 
     def do_genconfig(self, args, update=False):
         ''"""Usage: genconfig <filename>
-        Generate a new tracker config file (ini style) with default values
-        in <filename>.
+        Generate a new tracker config file (ini style) with default
+        values in <filename>.
         """
         if len(args) < 1:
             raise UsageError(_('Not enough arguments supplied'))
@@ -863,13 +863,14 @@
 
     def do_display(self, args):
         ''"""Usage: display designator[,designator]*
+
         Show the property values for the given node(s).
 
         A designator is a classname and a nodeid concatenated,
         eg. bug1, user10, ...
 
-        This lists the properties and their associated values for the given
-        node.
+        This lists the properties and their associated values
+        for the given node.
         """
         if len(args) < 1:
             raise UsageError(_('Not enough arguments supplied'))
@@ -1536,22 +1537,24 @@
 
     def do_migrate(self, args):
         ''"""Usage: migrate
+
         Update a tracker's database to be compatible with the Roundup
         codebase.
 
-        You should run the "migrate" command for your tracker once you've
-        installed the latest codebase.
+        You should run the "migrate" command for your tracker once
+        you've installed the latest codebase.
 
-        Do this before you use the web, command-line or mail interface and
-        before any users access the tracker.
+        Do this before you use the web, command-line or mail interface
+        and before any users access the tracker.
 
-        This command will respond with either "Tracker updated" (if you've
-        not previously run it on an RDBMS backend) or "No migration action
-        required" (if you have run it, or have used another interface to the
-        tracker, or possibly because you are using anydbm).
+        This command will respond with either "Tracker updated" (if
+        you've not previously run it on an RDBMS backend) or "No
+        migration action required" (if you have run it, or have used
+        another interface to the tracker, or possibly because you are
+        using anydbm).
 
-        It's safe to run this even if it's not required, so just get into
-        the habit.
+        It's safe to run this even if it's not required, so just get
+        into the habit.
         """
         if getattr(self.db, 'db_version_updated'):
             print(_('Tracker updated'))

Roundup Issue Tracker: http://roundup-tracker.org/