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

update inheritance docs 

- fixes #845
This commit is contained in:
Casper da Costa-Luis 2020-08-08 13:11:37 +01:00
parent f7722edecc
commit 3f3e391c2d
No known key found for this signature in database
GPG Key ID: 986B408043AE090D
2 changed files with 16 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
.meta/.readme.rst
View File

@ -298,7 +298,7 @@ of a neat one-line progress bar.
- 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 <https://github.com/tqdm/tqdm/issues/454#issuecomment-335416815>`__
(also `here <https://github.com/tqdm/tqdm/issues/499>`__). This is due to
@ -842,10 +842,13 @@ For further customisation,
Consider overloading ``display()`` to use e.g.
``self.frontend(**self.format_dict)`` instead of ``self.sp(repr(self))``.
`tqdm/notebook.py <https://github.com/tqdm/tqdm/blob/master/tqdm/notebook.py>`__
and `tqdm/gui.py <https://github.com/tqdm/tqdm/blob/master/tqdm/gui.py>`__
submodules are examples of inheritance which don't (yet) strictly conform to the
above recommendation.
Some submodule examples of inheritance which don't (yet) strictly conform to the
above recommendation:
- `tqdm/notebook.py <https://github.com/tqdm/tqdm/blob/master/tqdm/notebook.py>`__
- `tqdm/gui.py <https://github.com/tqdm/tqdm/blob/master/tqdm/gui.py>`__
- `tqdm/contrib/telegram.py <https://github.com/tqdm/tqdm/blob/master/tqdm/contrib/telegram.py>`__
- `tqdm/contrib/discord.py <https://github.com/tqdm/tqdm/blob/master/tqdm/contrib/discord.py>`__
Dynamic Monitor/Meter
~~~~~~~~~~~~~~~~~~~~~

13
README.rst
View File

@ -298,7 +298,7 @@ of a neat one-line progress bar.
- 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 <https://github.com/tqdm/tqdm/issues/454#issuecomment-335416815>`__
(also `here <https://github.com/tqdm/tqdm/issues/499>`__). This is due to
@ -1040,10 +1040,13 @@ For further customisation,
Consider overloading ``display()`` to use e.g.
``self.frontend(**self.format_dict)`` instead of ``self.sp(repr(self))``.
`tqdm/notebook.py <https://github.com/tqdm/tqdm/blob/master/tqdm/notebook.py>`__
and `tqdm/gui.py <https://github.com/tqdm/tqdm/blob/master/tqdm/gui.py>`__
submodules are examples of inheritance which don't (yet) strictly conform to the
above recommendation.
Some submodule examples of inheritance which don't (yet) strictly conform to the
above recommendation:
- `tqdm/notebook.py <https://github.com/tqdm/tqdm/blob/master/tqdm/notebook.py>`__
- `tqdm/gui.py <https://github.com/tqdm/tqdm/blob/master/tqdm/gui.py>`__
- `tqdm/contrib/telegram.py <https://github.com/tqdm/tqdm/blob/master/tqdm/contrib/telegram.py>`__
- `tqdm/contrib/discord.py <https://github.com/tqdm/tqdm/blob/master/tqdm/contrib/discord.py>`__
Dynamic Monitor/Meter
~~~~~~~~~~~~~~~~~~~~~