From bf9ca20ab9b432eeb54a2142b60cd03d2bb1546b Mon Sep 17 00:00:00 2001 From: Peter Cock Date: Fri, 27 Dec 2024 10:11:45 +0000 Subject: [PATCH] Fix method reference --- docs/source/progress.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/progress.rst b/docs/source/progress.rst index baeb3a25a..7c8e07295 100644 --- a/docs/source/progress.rst +++ b/docs/source/progress.rst @@ -131,7 +131,7 @@ Columns You may customize the columns in the progress display with the positional arguments to the :class:`~rich.progress.Progress` constructor. The columns are specified as either a `format string `_ or a :class:`~rich.progress.ProgressColumn` object. -Format strings will be rendered with a single value `"task"` which will be a :class:`~rich.progress.Task` instance. For example ``"{task.description}"`` would display the task description in the column, and ``"{task.completed} of {task.total}"`` would display how many of the total steps have been completed. Additional fields passed via keyword arguments to `~rich.progress.Progress.update` are stored in ``task.fields``. You can add them to a format string with the following syntax: ``"extra info: {task.fields[extra]}"``. +Format strings will be rendered with a single value `"task"` which will be a :class:`~rich.progress.Task` instance. For example ``"{task.description}"`` would display the task description in the column, and ``"{task.completed} of {task.total}"`` would display how many of the total steps have been completed. Additional fields passed via keyword arguments to :meth:`~rich.progress.Progress.update` are stored in ``task.fields``. You can add them to a format string with the following syntax: ``"extra info: {task.fields[extra]}"``. The default columns are equivalent to the following::