Skip to content

Commit aa950fa

Browse files
committed
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.
1 parent a5f8acc commit aa950fa

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

roundup/admin.py

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -503,8 +503,8 @@ def _get_choice(self, list_name, prompt, options, argument, default=None):
503503

504504
def do_genconfig(self, args, update=False):
505505
''"""Usage: genconfig <filename>
506-
Generate a new tracker config file (ini style) with default values
507-
in <filename>.
506+
Generate a new tracker config file (ini style) with default
507+
values in <filename>.
508508
"""
509509
if len(args) < 1:
510510
raise UsageError(_('Not enough arguments supplied'))
@@ -863,13 +863,14 @@ def do_specification(self, args):
863863

864864
def do_display(self, args):
865865
''"""Usage: display designator[,designator]*
866+
866867
Show the property values for the given node(s).
867868
868869
A designator is a classname and a nodeid concatenated,
869870
eg. bug1, user10, ...
870871
871-
This lists the properties and their associated values for the given
872-
node.
872+
This lists the properties and their associated values
873+
for the given node.
873874
"""
874875
if len(args) < 1:
875876
raise UsageError(_('Not enough arguments supplied'))
@@ -1536,22 +1537,24 @@ def do_security(self, args):
15361537

15371538
def do_migrate(self, args):
15381539
''"""Usage: migrate
1540+
15391541
Update a tracker's database to be compatible with the Roundup
15401542
codebase.
15411543
1542-
You should run the "migrate" command for your tracker once you've
1543-
installed the latest codebase.
1544+
You should run the "migrate" command for your tracker once
1545+
you've installed the latest codebase.
15441546
1545-
Do this before you use the web, command-line or mail interface and
1546-
before any users access the tracker.
1547+
Do this before you use the web, command-line or mail interface
1548+
and before any users access the tracker.
15471549
1548-
This command will respond with either "Tracker updated" (if you've
1549-
not previously run it on an RDBMS backend) or "No migration action
1550-
required" (if you have run it, or have used another interface to the
1551-
tracker, or possibly because you are using anydbm).
1550+
This command will respond with either "Tracker updated" (if
1551+
you've not previously run it on an RDBMS backend) or "No
1552+
migration action required" (if you have run it, or have used
1553+
another interface to the tracker, or possibly because you are
1554+
using anydbm).
15521555
1553-
It's safe to run this even if it's not required, so just get into
1554-
the habit.
1556+
It's safe to run this even if it's not required, so just get
1557+
into the habit.
15551558
"""
15561559
if getattr(self.db, 'db_version_updated'):
15571560
print(_('Tracker updated'))

0 commit comments

Comments
 (0)