./sage -fixdoctests: Update --help

Author: Matthias Koeppe

src/bin/sage-fixdoctests

@@ -48,29 +48,29 @@ from sage.features.all import all_features, module_feature, name_feature
 from sage.misc.temporary_file import tmp_filename
 
 parser = ArgumentParser(description="Given an input file with doctests, this creates a modified file that passes the doctests (modulo any raised exceptions). By default, the input file is modified. You can also name an output file.")
-parser.add_argument('-l', '--long',
-                    dest='long', action="store_true", default=False)
+parser.add_argument('-l', '--long', dest='long', action="store_true", default=False,
+                    help="include tests tagged '# long time'")
 parser.add_argument("--distribution", type=str, default='',
                     help="distribution package to test, e.g., 'sagemath-graphs', 'sagemath-combinat[modules]'; sets defaults for --venv and --environment")
 parser.add_argument("--venv", type=str, default='',
                     help="directory name of a venv where 'sage -t' is to be run")
 parser.add_argument("--environment", type=str, default='',
-                    help="name of a module that provides the global environment for tests; implies --keep-both and --full-tracebacks")
+                    help="name of a module that provides the global environment for tests, e.g., 'sage.all__sagemath_modules'; implies --keep-both and --full-tracebacks")
 parser.add_argument("--no-test", default=False, action="store_true",
                     help="do not run the doctester, only rewrite '# optional/needs' tags; implies --only-tags")
 parser.add_argument("--full-tracebacks", default=False, action="store_true",
                     help="include full tracebacks rather than '...'")
 parser.add_argument("--only-tags", default=False, action="store_true",
                     help="only add '# optional/needs' tags where needed, ignore other failures")
 parser.add_argument("--probe", metavar="FEATURES", type=str, default='',
-                    help="check whether '# optional - FEATURES' tags are still needed, remove these")
+                    help="check whether '# optional/needs' tags are still needed, remove these")
 parser.add_argument("--keep-both", default=False, action="store_true",
-                    help="do not replace test results; duplicate the test instead and mark both copies # optional")
+                    help="do not replace test results; duplicate the test instead, showing both results, and mark both copies '# optional'")
 parser.add_argument("--overwrite", default=False, action="store_true",
                     help="never interpret a second filename as OUTPUT; overwrite the source files")
 parser.add_argument("--no-overwrite", default=False, action="store_true",
                     help="never interpret a second filename as OUTPUT; output goes to files named INPUT.fixed")
-parser.add_argument("filename", nargs='*', help="input filenames; or INPUT_FILENAME OUTPUT_FILENAME if exactly two filenames are given and neither --overwrite nor --no-overwrite is present",
+parser.add_argument("filename", nargs='*', help="input filenames; or (deprecated) INPUT_FILENAME OUTPUT_FILENAME if exactly two filenames are given and neither --overwrite nor --no-overwrite is present",
                     type=str)
 
 args = parser.parse_args()