summaryrefslogtreecommitdiff
path: root/alot/commands/globals.py
diff options
context:
space:
mode:
authorDylan Baker <dylan@pnwbakers.com>2018-07-25 13:56:27 -0700
committerGitHub <noreply@github.com>2018-07-25 13:56:27 -0700
commit6ad6cbf33fe203e504c8623631746068850ee16f (patch)
tree63d5e46943761b9d49f3ffe4d3ae235ddd395ed6 /alot/commands/globals.py
parentce7bda011f1e0efe2edc8eb04311ca6bc384989f (diff)
parent474f7c8477ed6c88c56815a09cc98a7cabc4f70d (diff)
Merge pull request #1276 from alexshpilkin/copyedit
Copyedit documentation
Diffstat (limited to 'alot/commands/globals.py')
-rw-r--r--alot/commands/globals.py26
1 files changed, 14 insertions, 12 deletions
diff --git a/alot/commands/globals.py b/alot/commands/globals.py
index 9ebf2859..e2a39000 100644
--- a/alot/commands/globals.py
+++ b/alot/commands/globals.py
@@ -38,16 +38,18 @@ from ..utils import argparse as cargparse
MODE = 'global'
-@registerCommand(MODE, 'exit')
+@registerCommand(MODE, 'exit', help="shut down cleanly")
class ExitCommand(Command):
- """Shut down cleanly.
-
- The _prompt variable is for internal use only, it's used to control
- prompting to close without sending, and is used by the BufferCloseCommand
- if settings change after yielding to the UI.
- """
+ """Shut down cleanly."""
def __init__(self, _prompt=True, **kwargs):
+ """
+ :param _prompt: For internal use only, used to control prompting to
+ close without sending, and is used by the
+ BufferCloseCommand if settings change after yielding to
+ the UI.
+ :type _prompt: bool
+ """
super(ExitCommand, self).__init__(**kwargs)
self.prompt_to_send = _prompt
@@ -352,7 +354,7 @@ class PythonShellCommand(Command):
@registerCommand(MODE, 'repeat')
class RepeatCommand(Command):
- """Repeats the command executed last time"""
+ """repeat the command executed last time"""
def __init__(self, **kwargs):
Command.__init__(self, **kwargs)
@@ -367,7 +369,7 @@ class RepeatCommand(Command):
(['command'], {'help': 'python command string to call'})])
class CallCommand(Command):
- """Executes python code"""
+ """execute python code"""
repeatable = True
def __init__(self, command, **kwargs):
@@ -616,8 +618,8 @@ class FlushCommand(Command):
(['commandname'], {'help': 'command or \'bindings\''})])
class HelpCommand(Command):
- """display help for a command. Use \'bindings\' to display all keybings
- interpreted in current mode.'"""
+ """display help for a command (use \'bindings\' to display all keybindings
+ interpreted in current mode)"""
def __init__(self, commandname='', **kwargs):
"""
:param commandname: command to document
@@ -984,7 +986,7 @@ class MoveCommand(Command):
priority='error')
-@registerCommand(MODE, 'reload', help='Reload all configuration files')
+@registerCommand(MODE, 'reload', help='reload all configuration files')
class ReloadCommand(Command):
"""Reload configuration."""