summaryrefslogtreecommitdiff
path: root/alot
diff options
context:
space:
mode:
authorAlexander Shpilkin <ashpilkin@gmail.com>2018-07-24 21:30:22 +0200
committerAlexander Shpilkin <ashpilkin@gmail.com>2018-07-25 00:39:51 +0200
commit1a66f6764ead424c6bc83b50ad016db581489650 (patch)
tree8c33b32747022810fd601273522e8a98efd0b7eb /alot
parent32a5d7629b73b2191d6fd618836fc3b008903d79 (diff)
Capitalize option and command descriptions consistently
Diffstat (limited to 'alot')
-rw-r--r--alot/commands/envelope.py2
-rw-r--r--alot/commands/globals.py26
-rw-r--r--alot/commands/search.py7
-rw-r--r--alot/commands/thread.py6
4 files changed, 21 insertions, 20 deletions
diff --git a/alot/commands/envelope.py b/alot/commands/envelope.py
index 94d746cc..000e14db 100644
--- a/alot/commands/envelope.py
+++ b/alot/commands/envelope.py
@@ -621,7 +621,7 @@ class EncryptCommand(Command):
@registerCommand(
MODE, 'retag', forced={'action': 'set'},
arguments=[(['tags'], {'help': 'comma separated list of tags'})],
- help='set message tags.',
+ help='set message tags',
)
@registerCommand(
MODE, 'untag', forced={'action': 'remove'},
diff --git a/alot/commands/globals.py b/alot/commands/globals.py
index 0f1d6e26..eb451af5 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
@@ -983,7 +985,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."""
diff --git a/alot/commands/search.py b/alot/commands/search.py
index d1dccd71..2b8e4849 100644
--- a/alot/commands/search.py
+++ b/alot/commands/search.py
@@ -136,10 +136,9 @@ RetagPromptCommand = registerCommand(MODE, 'retagprompt')(RetagPromptCommand)
'default': 'True',
'help': 'postpone a writeout to the index'}),
(['tags'], {'help': 'comma separated list of tags'})],
- help='flip presence of tags on this thread. A tag is considered present '
- 'if at least one message contained in this thread is tagged with it. '
- 'In that case this command will remove the tag from every message in '
- 'the thread.')
+ help='flip presence of tags on this thread: a tag is considered present '
+ 'and will be removed if at least one message in this thread is '
+ 'tagged with it')
class TagCommand(Command):
"""manipulate message tags"""
diff --git a/alot/commands/thread.py b/alot/commands/thread.py
index b6eee44f..f2e85ad9 100644
--- a/alot/commands/thread.py
+++ b/alot/commands/thread.py
@@ -1069,9 +1069,9 @@ class MoveFocusCommand(MoveCommand):
@registerCommand(MODE, 'select')
class ThreadSelectCommand(Command):
- """select focussed element. The fired action depends on the focus:
- - if message summary, this toggles visibility of the message,
- - if attachment line, this opens the attachment"""
+ """select focussed element:
+ - if it is a message summary, toggle visibility of the message;
+ - if it is an attachment line, open the attachment"""
def apply(self, ui):
focus = ui.get_deep_focus()
if isinstance(focus, AttachmentWidget):