Rename "dump-completion" to "generate-completion"

Author: jimporter

CHANGES.md

@@ -5,7 +5,7 @@
 ### New features
 - Add support for [`!ENV`][mkdocs-env] and [`INHERIT`][mkdocs-inherit] in
   `mkdocs.yml`
-- Add `mike dump-completion` to generate shell-completion functions
+- Add `mike generate-completion` to generate shell-completion functions
 
 [mkdocs-env]: https://www.mkdocs.org/user-guide/configuration/#environment-variables
 [mkdocs-inherit]: https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance

README.md

@@ -41,7 +41,7 @@ pip install mike
 
 Once you've installed mike, you might also want to set up shell-completion for
 it. If you have [shtab][shtab] installed, you can do this with
-`mike dump-completion`, which will print the shell-completion code for your
+`mike generate-completion`, which will print the shell-completion code for your
 shell. For more details on how to set this up, consult shtab's
 [documentation][shtab-setup].
 

mike/driver.py

@@ -50,8 +50,9 @@
 Start the development server, serving pages from the target branch.
 """
 
-dump_completion_desc = """
-Print shell-completion functions.
+generate_completion_desc = """
+Generate shell-completion functions for bfg9000 and write them to standard
+output. This requires the Python package `shtab`.
 """
 
 
@@ -216,7 +217,7 @@ def help(parser, args):
     parser.parse_args(args.subcommand + ['--help'])
 
 
-def dump_completion(parser, args):
+def generate_completion(parser, args):
     try:
         import shtab
         print(shtab.complete(parser, shell=args.shell))
@@ -330,10 +331,10 @@ def main():
                         help='subcommand to request help for')
 
     completion_p = subparsers.add_parser(
-        'dump-completion', description=dump_completion_desc,
+        'generate-completion', description=generate_completion_desc,
         help='print shell completion script'
     )
-    completion_p.set_defaults(func=dump_completion)
+    completion_p.set_defaults(func=generate_completion)
     shell = (os.path.basename(os.environ['SHELL'])
              if 'SHELL' in os.environ else None)
     completion_p.add_argument('-s', '--shell', metavar='SHELL', default=shell,

test/integration/test_command_line.py

@@ -19,7 +19,7 @@ def test_help_subcommand_extra(self):
         self.assertRegex(output, r'^usage: mike deploy')
 
 
-class DumpCompletionTest(unittest.TestCase):
+class GenerateCompletionTest(unittest.TestCase):
     def test_completion(self):
-        output = assertPopen(['mike', 'dump-completion', '-sbash'])
+        output = assertPopen(['mike', 'generate-completion', '-sbash'])
         self.assertRegex(output, r'^#!/usr/bin/env bash')