Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

use code span in readme bar description #1474

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

use code span in readme bar description #1474

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
36084c2
bar readme code
trim21 May 19, 2023
80cc225
config
trim21 May 19, 2023
c27aa84
render
trim21 May 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 8 additions & 9 deletions README.rst
View file
Open in desktop
Expand Up @@ -426,15 +426,14 @@ Parameters
* bar_format : str, optional
Specify a custom bar string formatting. May impact performance.
[default: '{l_bar}{bar}{r_bar}'], where
l_bar='{desc}: {percentage:3.0f}%|' and
r_bar='| {n_fmt}/{total_fmt} [{elapsed}<{remaining}, '
'{rate_fmt}{postfix}]'
Possible vars: l_bar, bar, r_bar, n, n_fmt, total, total_fmt,
percentage, elapsed, elapsed_s, ncols, nrows, desc, unit,
rate, rate_fmt, rate_noinv, rate_noinv_fmt,
rate_inv, rate_inv_fmt, postfix, unit_divisor,
remaining, remaining_s, eta.
Note that a trailing ": " is automatically removed after {desc}
``l_bar='{desc}: {percentage:3.0f}%|'`` and
``r_bar='| {n_fmt}/{total_fmt} [{elapsed}<{remaining}, {rate_fmt}{postfix}]'``
Possible vars: ``l_bar``, ``bar``, ``r_bar``, ``n``, ``n_fmt``, ``total``, ``total_fmt``,
``percentage``, ``elapsed``, ``elapsed_s``, ``ncols``, ``nrows``, ``desc``, ``unit``,
``rate``, ``rate_fmt``, ``rate_noinv``, ``rate_noinv_fmt``,
``rate_inv``, ``rate_inv_fmt``, ``postfix``, ``unit_divisor``,
``remaining``, ``remaining_s``, ``eta``.
Note that a trailing ": " is automatically removed after ``{desc}``
if the latter is empty.
* initial : int or float, optional
The initial counter value. Useful when restarting a progress
Expand Down