mirrors/rich
1
0
Fork 0
mirror of https://github.com/Textualize/rich.git synced 2025-08-03 17:48:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs

Browse source
This commit is contained in:
Will McGugan 2020-08-12 21:16:40 +01:00
parent ce82bb67bb
commit 542ade896a
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/source/console.rst
View file

@ -102,11 +102,11 @@ To help with debugging, the log() method has a ``log_locals`` parameter. If you
Cropping
--------
The `~rich.console.Console.print` method has a boolean ``crop`` argument. The default value for crop is True which tells Rich to crop any content that would otherwise run on to the next line.
The :meth:`~rich.console.Console.print` method has a boolean ``crop`` argument. The default value for crop is True which tells Rich to crop any content that would otherwise run on to the next line.
If you set ``crop`` to False then long lines will be allowed to run on to the following line. This generally makes content hard to read, but it does mean that you can resize the console window after printing content.
If you set ``crop`` to False then long lines will be allowed to run on to the following line. This generally makes content hard to read, but it does mean that you can resize the terminal after printing to fit in more text.
Note that you generally don't need to think about cropping, as Rich will wrap text and resize other content so that it fits within the available width.
Note that you generally don't need to think about cropping, as Rich will wrap text and resize content to fit within the available width.
Justify / Alignment
@ -179,7 +179,7 @@ This produces the following output:
</span>
</pre>
You can also set overflow to "ignore" which allows text to run on to the next line. In practice this will look the same as "crop" unless you also set ``crop=False` in :meth:`~rich.console.Console.print`.
You can also set overflow to "ignore" which allows text to run on to the next line. In practice this will look the same as "crop" unless you also set ``crop=False`` when calling :meth:`~rich.console.Console.print`.
Input
-----