From d3f090f1c7457ff2cdf743cb2de4562061f3f59f Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Sat, 12 Jan 2019 12:07:47 +0000 Subject: [PATCH] fix minor typos --- CONTRIBUTING.md | 6 +++--- README.rst | 10 +++++----- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 465a0ff6..b0d2f12b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -164,7 +164,7 @@ git merge --no-ff pr-branch-name ### 5 Version -Modify tqdm/_version.py and ammend the last (merge) commit: +Modify tqdm/_version.py and amend the last (merge) commit: ``` git add tqdm/_version.py @@ -255,12 +255,12 @@ Additionally (less maintained), there exists: [gh-pages branch](https://github.com/tqdm/tqdm/tree/gh-pages), which is built using [asv](https://github.com/spacetelescope/asv/). - The [gh-pages root](https://tqdm.github.io/) which is built from a separate - outdated [github.io repo](https://github.com/tqdm/tqdm.github.io). + [github.io repo](https://github.com/tqdm/tqdm.github.io). ## QUICK DEV SUMMARY -For expereinced devs, once happy with local master: +For experienced devs, once happy with local master: 1. bump version in `tqdm/_version.py` 2. test (`[python setup.py] make alltests`) diff --git a/README.rst b/README.rst index 9d841509..d2fb28e8 100644 --- a/README.rst +++ b/README.rst @@ -232,7 +232,7 @@ of a neat one-line progress bar. to ensure nested bars stay within their respective lines. - Unicode: * Environments which report that they support unicode will have solid smooth - progressbars. The fallback is an `ascii`-only bar. + progressbars. The fallback is an ```ascii``-only bar. * Windows consoles often only partially support unicode and thus `often require explicit ascii=True `__ (also `here `__). This is due to @@ -282,7 +282,7 @@ Parameters len(iterable) is used if possible. If float("inf") or as a last resort, only basic progress statistics are displayed (no ETA, no progressbar). - If `gui` is True and this parameter needs subsequent updating, + If ``gui`` is True and this parameter needs subsequent updating, specify an initial arbitrary large positive integer, e.g. int(9e9). * leave : bool, optional @@ -327,8 +327,8 @@ Parameters automatically and a metric prefix following the International System of Units standard will be added (kilo, mega, etc.) [default: False]. If any other non-zero - number, will scale `total` and `n`. * dynamic_ncols : bool, optional + number, will scale ```total`` and ``n``. If set, constantly alters ``ncols`` to the environment (allowing for window resizes) [default: False]. * smoothing : float, optional @@ -357,7 +357,7 @@ Parameters Specify additional stats to display at the end of the bar. Calls ``set_postfix(**postfix)`` if possible (dict). * unit_divisor : float, optional - [default: 1000], ignored unless `unit_scale` is True. + [default: 1000], ignored unless ``unit_scale`` is True. Extra CLI Options ~~~~~~~~~~~~~~~~~ @@ -660,7 +660,7 @@ IPython/Jupyter is supported via the ``tqdm_notebook`` submodule: In addition to ``tqdm`` features, the submodule provides a native Jupyter widget (compatible with IPython v1-v4 and Jupyter), fully working nested bars -and color hints (blue: normal, green: completed, red: error/interrupt, +and colour hints (blue: normal, green: completed, red: error/interrupt, light blue: no ETA); as demonstrated below. |Screenshot-Jupyter1|