Rooba
/
tqdm
mirror of https://github.com/tqdm/tqdm.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Rebased README copyediting (#240)

This commit is contained in:
James Lu 2016-08-17 18:33:15 +02:00 committed by Casper da Costa-Luis
parent 0346a4a19f
commit 17bb11d607
1 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.rst
View File

@ -3,11 +3,11 @@
tqdm tqdm
==== ====
|PyPi-Status| |PyPi-Versions| |PyPI-Status| |PyPI-Versions|
|Build-Status| |Coverage-Status| |Branch-Coverage-Status| |Build-Status| |Coverage-Status| |Branch-Coverage-Status|
|DOI-URI| |Licence| |DOI-URI| |LICENCE|
``tqdm`` (read taqadum, تقدّم) means "progress" in arabic. ``tqdm`` (read taqadum, تقدّم) means "progress" in arabic.
@ -66,10 +66,10 @@ return \r`` and ``line feed \n`` control characters.
Installation Installation
------------ ------------
Latest pypi stable release Latest PyPI stable release
~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~
|PyPi-Status| |PyPI-Status|
.. code:: sh .. code:: sh
@ -78,7 +78,7 @@ Latest pypi stable release
Latest development release on github Latest development release on github
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|Github-Status| |Github-Stars| |Github-Forks| |GitHub-Status| |GitHub-Stars| |GitHub-Forks|
Pull and install in the current directory: Pull and install in the current directory:
@ -90,8 +90,8 @@ Pull and install in the current directory:
Changelog Changelog
--------- ---------
The list of all changes is available either on Github's Releases: The list of all changes is available either on GitHub's Releases:
|Github-Status| or on crawlers such as |GitHub-Status| or on crawlers such as
`allmychanges.com <https://allmychanges.com/p/python/tqdm/>`_. `allmychanges.com <https://allmychanges.com/p/python/tqdm/>`_.
@ -217,7 +217,7 @@ If you come across any other difficulties, browse/open issues
Documentation Documentation
------------- -------------
|PyPi-Versions| |Readme-Hits| (Since 19 May 2016) |PyPI-Versions| |README-Hits| (Since 19 May 2016)
.. code:: python .. code:: python
@ -711,10 +711,10 @@ now we have predictive information:
However, the progress is not smooth: it increments in steps, 1 step being However, the progress is not smooth: it increments in steps, 1 step being
1 file processed. The problem is that we do not just walk through files tree, 1 file processed. The problem is that we do not just walk through files tree,
but we process the files contents. Thus, if we stumble on one very large file but we process the files contents. Thus, if we stumble upon one very large file
which takes a great deal more time to process than other smaller files, which takes a great deal more time to process than other smaller files,
the progress bar the progress bar
will still considers that file is of equal processing weight. will still consider that file is of equal processing weight.
To fix this, we should use another indicator than the files count: the total To fix this, we should use another indicator than the files count: the total
sum of all files sizes. This would be more pertinent since the data we sum of all files sizes. This would be more pertinent since the data we
@ -756,7 +756,7 @@ predicted time and statistics:
Contributions Contributions
------------- -------------
All source code is hosted on `github <https://github.com/tqdm/tqdm>`__. All source code is hosted on `GitHub <https://github.com/tqdm/tqdm>`__.
Contributions are welcome. Contributions are welcome.
See the See the
@ -764,10 +764,10 @@ See the
file for more information. file for more information.
Licence LICENCE
------- -------
Open Source (OSI approved): |Licence| Open Source (OSI approved): |LICENCE|
Citation information: |DOI-URI| Citation information: |DOI-URI|
@ -786,7 +786,7 @@ Ranked by contributions.
`*` Original author `*` Original author
|Readme-Hits| (Since 19 May 2016) |README-Hits| (Since 19 May 2016)
.. |Logo| image:: https://raw.githubusercontent.com/tqdm/tqdm/master/logo.png .. |Logo| image:: https://raw.githubusercontent.com/tqdm/tqdm/master/logo.png
.. |Screenshot| image:: https://raw.githubusercontent.com/tqdm/tqdm/master/images/tqdm.gif .. |Screenshot| image:: https://raw.githubusercontent.com/tqdm/tqdm/master/images/tqdm.gif
@ -796,23 +796,23 @@ Ranked by contributions.
:target: https://coveralls.io/r/tqdm/tqdm :target: https://coveralls.io/r/tqdm/tqdm
.. |Branch-Coverage-Status| image:: https://codecov.io/github/tqdm/tqdm/coverage.svg?branch=master .. |Branch-Coverage-Status| image:: https://codecov.io/github/tqdm/tqdm/coverage.svg?branch=master
:target: https://codecov.io/github/tqdm/tqdm?branch=master :target: https://codecov.io/github/tqdm/tqdm?branch=master
.. |Github-Status| image:: https://img.shields.io/github/tag/tqdm/tqdm.svg?maxAge=2592000 .. |GitHub-Status| image:: https://img.shields.io/github/tag/tqdm/tqdm.svg?maxAge=2592000
:target: https://github.com/tqdm/tqdm/releases :target: https://github.com/tqdm/tqdm/releases
.. |Github-Forks| image:: https://img.shields.io/github/forks/tqdm/tqdm.svg .. |GitHub-Forks| image:: https://img.shields.io/github/forks/tqdm/tqdm.svg
:target: https://github.com/tqdm/tqdm/network :target: https://github.com/tqdm/tqdm/network
.. |Github-Stars| image:: https://img.shields.io/github/stars/tqdm/tqdm.svg .. |GitHub-Stars| image:: https://img.shields.io/github/stars/tqdm/tqdm.svg
:target: https://github.com/tqdm/tqdm/stargazers :target: https://github.com/tqdm/tqdm/stargazers
.. |PyPi-Status| image:: https://img.shields.io/pypi/v/tqdm.svg .. |PyPI-Status| image:: https://img.shields.io/pypi/v/tqdm.svg
:target: https://pypi.python.org/pypi/tqdm :target: https://pypi.python.org/pypi/tqdm
.. |PyPi-Downloads| image:: https://img.shields.io/pypi/dm/tqdm.svg .. |PyPI-Downloads| image:: https://img.shields.io/pypi/dm/tqdm.svg
:target: https://pypi.python.org/pypi/tqdm :target: https://pypi.python.org/pypi/tqdm
.. |PyPi-Versions| image:: https://img.shields.io/pypi/pyversions/tqdm.svg .. |PyPI-Versions| image:: https://img.shields.io/pypi/pyversions/tqdm.svg
:target: https://pypi.python.org/pypi/tqdm :target: https://pypi.python.org/pypi/tqdm
.. |Licence| image:: https://img.shields.io/pypi/l/tqdm.svg .. |LICENCE| image:: https://img.shields.io/pypi/l/tqdm.svg
:target: https://raw.githubusercontent.com/tqdm/tqdm/master/LICENCE :target: https://raw.githubusercontent.com/tqdm/tqdm/master/LICENCE
.. |DOI-URI| image:: https://zenodo.org/badge/21637/tqdm/tqdm.svg .. |DOI-URI| image:: https://zenodo.org/badge/21637/tqdm/tqdm.svg
:target: https://zenodo.org/badge/latestdoi/21637/tqdm/tqdm :target: https://zenodo.org/badge/latestdoi/21637/tqdm/tqdm
.. |Screenshot-Jupyter1| image:: https://raw.githubusercontent.com/tqdm/tqdm/master/images/tqdm-jupyter-1.gif .. |Screenshot-Jupyter1| image:: https://raw.githubusercontent.com/tqdm/tqdm/master/images/tqdm-jupyter-1.gif
.. |Screenshot-Jupyter2| image:: https://raw.githubusercontent.com/tqdm/tqdm/master/images/tqdm-jupyter-2.gif .. |Screenshot-Jupyter2| image:: https://raw.githubusercontent.com/tqdm/tqdm/master/images/tqdm-jupyter-2.gif
.. |Screenshot-Jupyter3| image:: https://raw.githubusercontent.com/tqdm/tqdm/master/images/tqdm-jupyter-3.gif .. |Screenshot-Jupyter3| image:: https://raw.githubusercontent.com/tqdm/tqdm/master/images/tqdm-jupyter-3.gif
.. |Readme-Hits| image:: http://hitt.herokuapp.com/tqdm/tqdm.svg .. |README-Hits| image:: http://hitt.herokuapp.com/tqdm/tqdm.svg