Skip to content

Commit

Permalink
Merge pull request #2772 from jwilk-forks/spelling
Browse files Browse the repository at this point in the history
Fix typos
  • Loading branch information
willmcgugan committed Jan 23, 2023
2 parents 8c297cb + e94d98d commit 44cf059
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/source/progress.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Transient progress displays are useful if you want more minimal output in the te
Indeterminate progress
~~~~~~~~~~~~~~~~~~~~~~

When you add a task it is automatically *started*, which means it will show a progress bar at 0% and the time remaining will be calculated from the current time. This may not work well if there is a long delay before you can start updating progress; you may need to wait for a response from a server or count files in a directory (for example). In these cases you can call :meth:`~rich.progress.Progress.add_task` with ``start=False`` or ``total=None`` which will display a pulsing animation that lets the user know something is working. This is know as an *indeterminate* progress bar. When you have the number of steps you can call :meth:`~rich.progress.Progress.start_task` which will display the progress bar at 0%, then :meth:`~rich.progress.Progress.update` as normal.
When you add a task it is automatically *started*, which means it will show a progress bar at 0% and the time remaining will be calculated from the current time. This may not work well if there is a long delay before you can start updating progress; you may need to wait for a response from a server or count files in a directory (for example). In these cases you can call :meth:`~rich.progress.Progress.add_task` with ``start=False`` or ``total=None`` which will display a pulsing animation that lets the user know something is working. This is known as an *indeterminate* progress bar. When you have the number of steps you can call :meth:`~rich.progress.Progress.start_task` which will display the progress bar at 0%, then :meth:`~rich.progress.Progress.update` as normal.

Auto refresh
~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/syntax.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The Syntax constructor (and :meth:`~rich.syntax.Syntax.from_path`) accept a ``th
Background color
----------------

You can override the background color from the theme by supplying a ``background_color`` argument to the constructor. This should be a string in the same format a style definition accepts, .e.g "red", "#ff0000", "rgb(255,0,0)" etc. You may also set the special value "default" which will use the default background color set in the terminal.
You can override the background color from the theme by supplying a ``background_color`` argument to the constructor. This should be a string in the same format a style definition accepts, e.g. "red", "#ff0000", "rgb(255,0,0)" etc. You may also set the special value "default" which will use the default background color set in the terminal.


Syntax CLI
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tables.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ There are a number of keyword arguments on the Table constructor you can use to
- ``min_width`` Sets a minimum width for the table.
- ``box`` Sets one of the :ref:`appendix_box` styles for the table grid, or ``None`` for no grid.
- ``safe_box`` Set to ``True`` to force the table to generate ASCII characters rather than unicode.
- ``padding`` A integer, or tuple of 1, 2, or 4 values to set the padding on cells.
- ``padding`` An integer, or tuple of 1, 2, or 4 values to set the padding on cells.
- ``collapse_padding`` If True the padding of neighboring cells will be merged.
- ``pad_edge`` Set to False to remove padding around the edge of the table.
- ``expand`` Set to True to expand the table to the full available size.
Expand Down

0 comments on commit 44cf059

Please sign in to comment.