Browse Source

improve documentation

Justin Tracey 3 years ago
parent
commit
5caf616723
1 changed files with 16 additions and 16 deletions
  1. 16 16
      vice-speaker-rotator.py

+ 16 - 16
vice-speaker-rotator.py

@@ -200,11 +200,11 @@ can also be ranges of ISO formatted dates (yyyy-mm-dd--yyyy-mm-dd).''',
                         'date of the first meeting')
     parser.add_argument('-e', '--end', metavar = 'DATE',
                         help =
-                        'last date to schedule a meeting on or before\n' +\
+                        'last date to schedule a meeting on or before\n' \
                         '(if -w also specified, uses whatever is shortest)')
     parser.add_argument('-w', '--weeks', type=int,
                         help =
-                        'number of weeks to schedule for\n' +\
+                        'number of weeks to schedule for\n' \
                         '(if -e also specified, uses whatever is shortest)')
 
     group = parser.add_mutually_exclusive_group()
@@ -215,24 +215,24 @@ can also be ranges of ISO formatted dates (yyyy-mm-dd--yyyy-mm-dd).''',
     group.add_argument('-f', '--namesfile',
                        metavar = 'FILE',
                        help =
-                       'path of a file that contains a comma-seperated\n' +\
+                       'path of a file that contains a comma-seperated\n' \
                        ' list of names to schedule in their speaking order')
 
     parser.add_argument('-c', '--constraintsfile',
                         metavar = 'FILE',
                         help =
-                        'Provide constraints, practice talks, and notes\n' +\
-                        'via supplied csv file. The CSV can contain the\n' +\
-                        'following lines:\n' +\
-                        'constraints - dates where someone cannot speak:\n' +\
-                        '"c,[name],[date1],[date2],[...]"\n' +\
-                        'notes - goes in the notes column for that date:\n' +\
-                        '"n,[date],[note]"\n' +\
-                        'practice talks - dates where something other than\n' +\
-                        'the usual CrySP meeting talks is happening:\n' +\
-                        '"p,[name],[date],[note (e.g., "practice talk")]"\n' +\
-                        'half-slot - a rare case where someone/thing needs\n' +\
-                        'only one of the speaker slots on this date:\n' +\
+                        'Provide constraints, practice talks, and notes\n' \
+                        'via supplied CSV file. The CSV can contain the\n' \
+                        'following lines:\n' \
+                        'constraints - dates where someone cannot speak:\n' \
+                        '"c,[name],[date/range1],[date/range2],[...]"\n' \
+                        'notes - goes in the notes column for that date:\n' \
+                        '"n,[date],[note]"\n' \
+                        'practice talks - dates where something other than\n' \
+                        'the usual CrySP meeting talks is happening:\n' \
+                        '"p,[name],[date],[note (e.g., "practice talk")]"\n' \
+                        'half-slot - a rare case where someone/thing needs\n' \
+                        'only one of the speaker slots on this date:\n' \
                         '"h,[name],[date],[note]"\n')
 
     parser.add_argument('-r', '--no-repeat',
@@ -243,7 +243,7 @@ can also be ranges of ISO formatted dates (yyyy-mm-dd--yyyy-mm-dd).''',
                         nargs = '?', const = 2, default = False,
                         metavar = 'WEEKS',
                         help =
-                        'print an email for notifying who is speaking\n' +\
+                        'print an email for notifying who is speaking\n' \
                         'the next two (or specified) weeks')
     return parser