mirrors/rich
1
0
Fork 0
mirror of https://github.com/Textualize/rich.git synced 2025-08-04 01:58:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

rearrange docs

Browse source
This commit is contained in:
Will McGugan 2020-12-13 13:05:24 +00:00
parent 1d0d12b550
commit c8fac003f0
1 changed files with 9 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/source/console.rst
View file

@ -69,6 +69,15 @@ The :meth:`~rich.console.Console.log` methods offers the same capabilities as pr
To help with debugging, the log() method has a ``log_locals`` parameter. If you set this to ``True``, Rich will display a table of local variables where the method was called.
Low level output
----------------
In additional to :meth:`~rich.console.Console.print` and :meth:`~rich.console.Console.log`, Rich has a :meth:`~rich.console.Console.out` method which provides a lower-level way of writing to the terminal. The out() method converts all the positional arguments to strings and won't pretty print, word wrap, or apply markup to the output, but can apply a basic style and will optionally do highlighting.
Here's an example::
>>> console.out("Locals", locals())
Rules
-----
@ -101,16 +110,6 @@ You can change the spinner animation via the ``spinner`` parameter. Run the foll
python -m rich.spinner
Low level output
----------------
In additional to :meth:`~rich.console.Console.print` and :meth:`~rich.console.Console.log`, Rich has a :meth:`~rich.console.Console.out` method which provides a lower-level way of writing to the terminal. The out() method converts all the positional arguments to strings and won't pretty print, word wrap, or apply markup to the output, but can apply a basic style and will optionally do highlighting.
Here's an example::
>>> console.out("Locals", locals())
Justify / Alignment
-------------------