diff options
| author | Jonathan Slenders <jonathan@slenders.be> | 2018-06-02 17:09:01 +0200 |
|---|---|---|
| committer | Jonathan Slenders <jonathan@slenders.be> | 2018-06-02 17:09:01 +0200 |
| commit | 2c1f8f657b6516c2bf0f0e9e527bcf2de9ac73fb (patch) | |
| tree | 940b9630005cb0614135be15100ae748be6952a5 | |
| parent | 93fde3443a1a81691bdf17c81578d45e99034b4f (diff) | |
Small documentation improvements.
| -rw-r--r-- | docs/index.rst | 4 | ||||
| -rw-r--r-- | docs/pages/advanced_topics/asyncio.rst | 9 | ||||
| -rw-r--r-- | docs/pages/asking_for_input.rst | 4 | ||||
| -rw-r--r-- | docs/pages/full_screen_apps.rst | 4 |
4 files changed, 11 insertions, 10 deletions
diff --git a/docs/index.rst b/docs/index.rst index 156eed4a..82dd891a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ -Python Prompt Toolkit -===================== +Python Prompt Toolkit 2.0 +========================= .. warning:: diff --git a/docs/pages/advanced_topics/asyncio.rst b/docs/pages/advanced_topics/asyncio.rst index c5b202a1..96505fa3 100644 --- a/docs/pages/advanced_topics/asyncio.rst +++ b/docs/pages/advanced_topics/asyncio.rst @@ -1,11 +1,12 @@ .. _asyncio: -Running on top of the ``asyncio`` event loop -============================================ +Running on top of the `asyncio` event loop +========================================== Prompt_toolkit has a built-in event loop of its own. However, in modern -applications, you probably want to use asyncio for everything. With just one -line of code, it is possible to run prompt_toolkit on top of asyncio: +applications, you probably want to use `asyncio +<https://docs.python.org/3/library/asyncio.html>`_ for everything. With just +one line of code, it is possible to run prompt_toolkit on top of asyncio: .. code:: diff --git a/docs/pages/asking_for_input.rst b/docs/pages/asking_for_input.rst index ab18c0c5..7d0b0665 100644 --- a/docs/pages/asking_for_input.rst +++ b/docs/pages/asking_for_input.rst @@ -866,8 +866,8 @@ asterisks (``*`` characters). prompt('Enter password: ', is_password=True) -Prompt in an ``asyncio`` application ------------------------------------- +Prompt in an `asyncio` application +---------------------------------- For `asyncio <https://docs.python.org/3/library/asyncio.html>`_ applications, it's very important to never block the eventloop. However, diff --git a/docs/pages/full_screen_apps.rst b/docs/pages/full_screen_apps.rst index 71c1b84e..8c406a12 100644 --- a/docs/pages/full_screen_apps.rst +++ b/docs/pages/full_screen_apps.rst @@ -363,8 +363,8 @@ the content, but there are much more options. - Finally, the background can be filled with a default character. -More about buffers and :class:`~prompt_toolkit.layout.BufferControl` --------------------------------------------------------------------- +More about buffers and `BufferControl` +-------------------------------------- |