From 293b32ce20132f410795c10ac35886c2a97c8983 Mon Sep 17 00:00:00 2001 From: Dave Pearson Date: Thu, 20 Oct 2022 10:21:44 +0100 Subject: [PATCH 1/3] methods -> method --- docs/source/console.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/console.rst b/docs/source/console.rst index 003e78ac..20c6b7df 100644 --- a/docs/source/console.rst +++ b/docs/source/console.rst @@ -58,7 +58,7 @@ You can also use :meth:`~rich.console.Console.print` to render objects that supp Logging ------- -The :meth:`~rich.console.Console.log` methods offers the same capabilities as print, but adds some features useful for debugging a running application. Logging writes the current time in a column to the left, and the file and line where the method was called to a column on the right. Here's an example:: +The :meth:`~rich.console.Console.log` method offers the same capabilities as print, but adds some features useful for debugging a running application. Logging writes the current time in a column to the left, and the file and line where the method was called to a column on the right. Here's an example:: >>> console.log("Hello, World!") From 74c5d2d6d0edb23b9bb2abd2b1cff68cb2113a83 Mon Sep 17 00:00:00 2001 From: Dave Pearson Date: Thu, 20 Oct 2022 10:23:30 +0100 Subject: [PATCH 2/3] Swap to "an out method" rather than "a out method" --- docs/source/console.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/console.rst b/docs/source/console.rst index 20c6b7df..f2d6d42f 100644 --- a/docs/source/console.rst +++ b/docs/source/console.rst @@ -94,7 +94,7 @@ You can also pretty print JSON via the command line with the following:: 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. +In additional to :meth:`~rich.console.Console.print` and :meth:`~rich.console.Console.log`, Rich has an :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:: From e27258dd10182fef164dc471ac12522163baa5a7 Mon Sep 17 00:00:00 2001 From: Dave Pearson Date: Thu, 20 Oct 2022 10:26:42 +0100 Subject: [PATCH 3/3] stop -> stops --- docs/source/console.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/console.rst b/docs/source/console.rst index f2d6d42f..5c0aeb32 100644 --- a/docs/source/console.rst +++ b/docs/source/console.rst @@ -122,7 +122,7 @@ Rich can display a status message with a 'spinner' animation that won't interfer python -m rich.status -To display a status message, call :meth:`~rich.console.Console.status` with the status message (which may be a string, Text, or other renderable). The result is a context manager which starts and stop the status display around a block of code. Here's an example:: +To display a status message, call :meth:`~rich.console.Console.status` with the status message (which may be a string, Text, or other renderable). The result is a context manager which starts and stops the status display around a block of code. Here's an example:: with console.status("Working..."): do_work()