summaryrefslogtreecommitdiffstats
path: root/prompt_toolkit
diff options
context:
space:
mode:
authorJonathan Slenders <jonathan@slenders.be>2018-05-16 22:00:12 +0200
committerJonathan Slenders <jonathan@slenders.be>2018-05-16 22:00:12 +0200
commit70efbc5f2493e881170635f0e2bf951e0264a916 (patch)
treeec641e1fd2fc7a6889c74d6312f1412736317775 /prompt_toolkit
parentc2c9e23900a72a01c27cbd98142f0cb6e33f2a22 (diff)
Moved SQLite tutorial in Sphinx documentation + other documentation improvements.
Diffstat (limited to 'prompt_toolkit')
-rw-r--r--prompt_toolkit/completion.py2
-rw-r--r--prompt_toolkit/layout/__init__.py5
-rw-r--r--prompt_toolkit/shortcuts/prompt.py10
3 files changed, 11 insertions, 6 deletions
diff --git a/prompt_toolkit/completion.py b/prompt_toolkit/completion.py
index c1ae589d..b8439df6 100644
--- a/prompt_toolkit/completion.py
+++ b/prompt_toolkit/completion.py
@@ -38,7 +38,7 @@ class Completion(object):
assert isinstance(start_position, int)
assert display is None or isinstance(display, text_type)
assert display_meta is None or isinstance(display_meta, text_type)
- assert get_display_meta is None or callable(get_display_meta)
+ assert get_display_meta is None or callable(get_display_meta) # XXX: remove attr, accept callable for display_meta.
assert isinstance(style, text_type)
assert isinstance(selected_style, text_type)
diff --git a/prompt_toolkit/layout/__init__.py b/prompt_toolkit/layout/__init__.py
index db6ed96b..14148ae5 100644
--- a/prompt_toolkit/layout/__init__.py
+++ b/prompt_toolkit/layout/__init__.py
@@ -45,9 +45,10 @@ And one prepared menu:
"""
from __future__ import unicode_literals
-from .layout import Layout, InvalidLayoutError, walk
-from .containers import Container, HSplit, VSplit, FloatContainer, Float, Window, WindowRenderInfo, ConditionalContainer, ScrollOffsets, ColorColumn, to_container, to_window, is_container
+from .containers import Container, HSplit, VSplit, FloatContainer, Float, Window, WindowRenderInfo, ConditionalContainer, ScrollOffsets, ColorColumn, to_container, to_window, is_container, HorizontalAlign, VerticalAlign
from .controls import BufferControl, SearchBufferControl, DummyControl, FormattedTextControl, UIControl, UIContent
+from .dimension import Dimension, D, sum_layout_dimensions, max_layout_dimensions, to_dimension, is_dimension
+from .layout import Layout, InvalidLayoutError, walk
from .margins import Margin, NumberedMargin, ScrollbarMargin, ConditionalMargin, PromptMargin
from .menus import CompletionsMenu, MultiColumnCompletionsMenu
diff --git a/prompt_toolkit/shortcuts/prompt.py b/prompt_toolkit/shortcuts/prompt.py
index 000515b3..ce9647da 100644
--- a/prompt_toolkit/shortcuts/prompt.py
+++ b/prompt_toolkit/shortcuts/prompt.py
@@ -670,10 +670,14 @@ class PromptSession(object):
tempfile_suffix=None, inputhook=None,
async_=False):
"""
- Display the prompt. All the arguments are the same as for the
- :class:`~.PromptSession` class.
+ Display the prompt. All the arguments are a subset of the
+ :class:`~.PromptSession` class itself.
- :param _async: When `True` return a `Future` instead of waiting for the
+ This will raise ``KeyboardInterrupt`` when control-c has been pressed
+ (for abort) and ``EOFError`` when control-d has been pressed (for
+ exit).
+
+ :param async_: When `True` return a `Future` instead of waiting for the
prompt to finish.
"""
# Backup original settings.