minor formatting in doc

4dn-dcic · Mar 12, 2020 · 5a3250d · 5a3250d
1 parent 8eeddf2
commit 5a3250d
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 24 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -132,25 +132,24 @@ To remove Tibanna components on AWS.
 
 ::
 
-  suffix=<suffixname>            If suffix was used to deploy a tibanna, it should be added here.
-                                 The step function and lambda functions will have the suffix at the end.
+  suffix=<suffixname>            If suffix was used to deploy a tibanna, it should be added
+                                 here. The step function and lambda functions will have the
+                                 suffix at the end.
 
-  usergroup=<usergroup>          Tibanna usergroup to share the permission to access
-                                 buckets and run jobs
-
-  ignore_errors=True|False       if True, if any of the components does not exist (e.g. already removed),
-                                 it does not throw an error and keeps on to remove the other components.
-                                 (default True)
+  ignore_errors=<True|False>     If True, if any of the components does not exist (e.g.
+                                 already removed), it does not throw an error and keeps on
+                                 to remove the other components. (default True)
 
-  do_not_remove_iam_group=True|False
-                                 if True, does not remove the IAM permission. This option is recommended if various
-                                 suffices are used to share the same usergroup. (default False)
+  do_not_remove_iam_group<True|False>
+                                 If True, does not remove the IAM permission. This option is
+                                 recommended if various suffices are used to share the same
+                                 usergroup. (default False)
 
-  purge_history=True|False       if True, remove all the job logs and other job-related files from S3 bucket
-                                 and dynamoDB. Please use with caution. (default False)
+  purge_history=<True|False>     If True, remove all the job logs and other job-related files
+                                 from S3 bucket and dynamoDB. Please use with caution.
+                                 (default False)
 
-  verbose=True|False             verbose if True.
-  
+  verbose=<True|False>           Verbose if True. (default False)
 
 
 Non-admin

diff --git a/docs/commands.rst b/docs/commands.rst
@@ -140,18 +140,21 @@ To remove Tibanna components on AWS.
 ::
 
 
-  -s|--suffix=<suffixname>            If suffix was used to deploy a tibanna, it should be added here.
-                                      The step function and lambda functions will have the suffix at the end.
+  -s|--suffix=<suffixname>            If suffix was used to deploy a tibanna, it should be added
+                                      here. The step function and lambda functions will have the
+                                      suffix at the end.
 
-  -E|--do-not-ignore-errors           By default, if any of the components does not exist (e.g. already removed),
-                                      it does not throw an error and keeps on to remove the other components.
-                                      Using this option turns off this feature and will throw an error.
+  -E|--do-not-ignore-errors           By default, if any of the components does not exist (e.g.
+                                      already removed), it does not throw an error and keeps on
+                                      to remove the other components. Using this option turns off
+                                      this feature and will throw an error.
 
-  -G|--do-not-remove-iam-group        if set, it does not remove the IAM permissions. This option is recommended if
-                                      various suffices are used to share the same usergroup.
+  -G|--do-not-remove-iam-group        if set, it does not remove the IAM permissions. This option
+                                      is recommended if various suffices are used to share the
+                                      same usergroup.
 
-  -p|--purge-history                  if set, remove all the job logs and other job-related files from S3 bucket
-                                      and dynamoDB. Please use with caution.
+  -p|--purge-history                  if set, remove all the job logs and other job-related files
+                                      from S3 bucket and dynamoDB. Please use with caution.
 
   -q|--quiet                          run quietly