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

add JOSS DOI, minor documentation code fix

This commit is contained in:
Casper da Costa-Luis 2019-05-19 20:50:34 +01:00
parent 4ffe458de3
commit f3ad68ef60
No known key found for this signature in database
GPG Key ID: 986B408043AE090D
2 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
.meta/.readme.rst
View File

@ -7,7 +7,7 @@ tqdm
|Build-Status| |Coverage-Status| |Branch-Coverage-Status| |Codacy-Grade| |Libraries-Rank| |PyPI-Downloads|
|DOI-URI| |LICENCE| |OpenHub-Status| |binder-demo| |notebook-demo|
|DOI| |LICENCE| |OpenHub-Status| |binder-demo| |notebook-demo|
``tqdm`` means "progress" in Arabic (*taqadum*, تقدّم)
@ -283,7 +283,7 @@ Documentation
.. code:: python
class tqdm(object):
class tqdm():
"""{DOC_tqdm}"""
def __init__(self, iterable=None, desc=None, total=None, leave=True,
@ -307,6 +307,7 @@ Returns
{DOC_tqdm.tqdm.__init__.Returns}
.. code:: python
class tqdm():
def update(self, n=1):
"""{DOC_tqdm.tqdm.update}"""
@ -826,7 +827,7 @@ LICENCE
Open Source (OSI approved): |LICENCE|
Citation information: |DOI-URI|
Citation information: |DOI| (publication), |DOI-code| (code)
|README-Hits| (Since 19 May 2016)
@ -878,7 +879,9 @@ Citation information: |DOI-URI|
:target: https://www.openhub.net/p/tqdm?ref=Thin+badge
.. |LICENCE| image:: https://img.shields.io/pypi/l/tqdm.svg
:target: https://raw.githubusercontent.com/tqdm/tqdm/master/LICENCE
.. |DOI-URI| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.595120-blue.svg
.. |DOI| image:: https://img.shields.io/badge/DOI-10.21105/joss.01277-green.svg
:target: https://doi.org/10.21105/joss.01277
.. |DOI-code| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.595120-blue.svg
:target: https://doi.org/10.5281/zenodo.595120
.. |notebook-demo| image:: https://img.shields.io/badge/launch-notebook-orange.svg?logo=jupyter
:target: https://notebooks.ai/demo/gh/tqdm/tqdm

11
README.rst
View File

@ -7,7 +7,7 @@ tqdm
|Build-Status| |Coverage-Status| |Branch-Coverage-Status| |Codacy-Grade| |Libraries-Rank| |PyPI-Downloads|
|DOI-URI| |LICENCE| |OpenHub-Status| |binder-demo| |notebook-demo|
|DOI| |LICENCE| |OpenHub-Status| |binder-demo| |notebook-demo|
``tqdm`` means "progress" in Arabic (*taqadum*, تقدّم)
@ -283,7 +283,7 @@ Documentation
.. code:: python
class tqdm(object):
class tqdm():
"""
Decorate an iterable object, returning an iterator which acts exactly
like the original iterable, but prints a dynamically updating
@ -416,6 +416,7 @@ Returns
.. code:: python
class tqdm():
def update(self, n=1):
"""
Manually update the progress bar, useful for streams
@ -990,7 +991,7 @@ LICENCE
Open Source (OSI approved): |LICENCE|
Citation information: |DOI-URI|
Citation information: |DOI| (publication), |DOI-code| (code)
|README-Hits| (Since 19 May 2016)
@ -1042,7 +1043,9 @@ Citation information: |DOI-URI|
:target: https://www.openhub.net/p/tqdm?ref=Thin+badge
.. |LICENCE| image:: https://img.shields.io/pypi/l/tqdm.svg
:target: https://raw.githubusercontent.com/tqdm/tqdm/master/LICENCE
.. |DOI-URI| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.595120-blue.svg
.. |DOI| image:: https://img.shields.io/badge/DOI-10.21105/joss.01277-green.svg
:target: https://doi.org/10.21105/joss.01277
.. |DOI-code| image:: https://img.shields.io/badge/DOI-10.5281/zenodo.595120-blue.svg
:target: https://doi.org/10.5281/zenodo.595120
.. |notebook-demo| image:: https://img.shields.io/badge/launch-notebook-orange.svg?logo=jupyter
:target: https://notebooks.ai/demo/gh/tqdm/tqdm