diff --git a/docs/changes.rst b/docs/changes.rst index bc12c038..21c43f74 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -15,8 +15,11 @@ Unreleased **Added** ^^^^^^^^^^ -- :meth:`quo.console.Console.pager` -- :param:`fmt` to :func:`quo.print` +- Added :meth:`quo.console.Console.pager` +- Added :param:`fmt` to :func:`quo.print` +- Added :param:`bg` to all dialog boxes. +- Added :param:`multiline` to :func:`quo.dialog.InputBox` +- Added `TextField` as an aliase to :class:`TextArea` **Changed** ^^^^^^^^^^^^ diff --git a/docs/dialogs.rst b/docs/dialogs.rst index 0803ea7b..1ce3a60b 100644 --- a/docs/dialogs.rst +++ b/docs/dialogs.rst @@ -4,6 +4,8 @@ Dialogs ======= Quo ships with a high level API for displaying `dialog boxes `_ to the user for informational purposes, or get input from the user. +All dialogs can be passed ``bg=False`` option to turn off the background. *Added on v2022.4* + *Deprecated :meth:`.run` on v2022.3.2* ``Message Box`` @@ -37,9 +39,8 @@ input box. It will return the user input as a string. text='Please type your name:') .. image:: ./images/inputbox.png - -The ``hide=True`` option can be passed to the -:func:`~quo.dialog.InputBox` function to turn this into a password input box. +The ``multiline=True`` option can be passed turn this into a multiline Input box +The ``hide=True`` option can be passed to the :func:`~quo.dialog.InputBox` function to turn this into a password input box. ``Confirm Box`` diff --git a/docs/filters.rst b/docs/filters.rst index e657427f..1bbc1d21 100644 --- a/docs/filters.rst +++ b/docs/filters.rst @@ -33,8 +33,8 @@ from a function. For instance, the following condition will evaluate to ``True`` .. code:: python - from quo import Condition from quo.console import get_app + from quo.filters import Condition @Condition def is_searching(): @@ -137,8 +137,7 @@ instance, and always returns a :class:`~quo.filters.Filter`. .. code:: python - from quo import Condition - from quo.filters import to_filter, has_search, has_selection + from quo.filters import Condition, to_filter, has_search, has_selection # In each of the following three examples, 'f' will be a `Filter` # instance. diff --git a/docs/kb.rst b/docs/kb.rst index 908168f9..ada7f750 100644 --- a/docs/kb.rst +++ b/docs/kb.rst @@ -190,7 +190,7 @@ pass it to :class:`~quo.Condition` instance. (:ref:`Read more about filters