Skip to content

Commit 4c19cac

Browse files
committed
Doc: fix some typos
Signed-off-by: Louis Sautier <sautier.louis@gmail.com>
1 parent e1e6d74 commit 4c19cac

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

docs/source/progress.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ Columns
131131

132132
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 <https://docs.python.org/3/library/string.html#formatspec>`_ or a :class:`~rich.progress.ProgressColumn` object.
133133

134-
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 store in ``task.fields``. You can add them to a format string with the following syntax: ``"extra info: {task.fields[extra]}"``.
134+
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]}"``.
135135

136136
The default columns are equivalent to the following::
137137

rich/live.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class Live(JupyterMixin, RenderHook):
3737
3838
Args:
3939
renderable (RenderableType, optional): The renderable to live display. Defaults to displaying nothing.
40-
console (Console, optional): Optional Console instance. Default will an internal Console instance writing to stdout.
40+
console (Console, optional): Optional Console instance. Defaults to an internal Console instance writing to stdout.
4141
screen (bool, optional): Enable alternate screen mode. Defaults to False.
4242
auto_refresh (bool, optional): Enable auto refresh. If disabled, you will need to call `refresh()` or `update()` with refresh flag. Defaults to True
4343
refresh_per_second (float, optional): Number of times per second to refresh the live display. Defaults to 4.

rich/progress.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1056,7 +1056,7 @@ class Progress(JupyterMixin):
10561056
"""Renders an auto-updating progress bar(s).
10571057
10581058
Args:
1059-
console (Console, optional): Optional Console instance. Default will an internal Console instance writing to stdout.
1059+
console (Console, optional): Optional Console instance. Defaults to an internal Console instance writing to stdout.
10601060
auto_refresh (bool, optional): Enable auto refresh. If disabled, you will need to call `refresh()`.
10611061
refresh_per_second (Optional[float], optional): Number of times per second to refresh the progress information or None to use default (10). Defaults to None.
10621062
speed_estimate_period: (float, optional): Period (in seconds) used to calculate the speed estimate. Defaults to 30.

0 commit comments

Comments
 (0)