Skip to content

Commit

Permalink
misc documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
casperdcl committed Mar 5, 2021
1 parent 1e50916 commit 28823f4
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 24 deletions.
11 changes: 7 additions & 4 deletions .meta/.readme.rst
Expand Up @@ -140,7 +140,7 @@ Changelog
The list of all changes is available either on GitHub's Releases:
|GitHub-Status|, on the
`wiki <https://github.com/tqdm/tqdm/wiki/Releases>`__, or on the
`website <https://tqdm.github.io/releases/>`__.
`website <https://tqdm.github.io/releases>`__.


Usage
Expand Down Expand Up @@ -460,7 +460,10 @@ Submodules
"""`rich.progress` version."""
class tqdm.keras.TqdmCallback(keras.callbacks.Callback):
"""`keras` callback for epoch and batch progress."""
"""Keras callback for epoch and batch progress."""
class tqdm.dask.TqdmCallback(dask.callbacks.Callback):
"""Dask callback for task progress."""
``contrib``
Expand All @@ -470,8 +473,8 @@ The ``tqdm.contrib`` package also contains experimental modules:

- ``tqdm.contrib.itertools``: Thin wrappers around ``itertools``
- ``tqdm.contrib.concurrent``: Thin wrappers around ``concurrent.futures``
- ``tqdm.contrib.discord``: Posts to `Discord <https://discord.com/>`__ bots
- ``tqdm.contrib.telegram``: Posts to `Telegram <https://telegram.org/>`__ bots
- ``tqdm.contrib.discord``: Posts to `Discord <https://discord.com>`__ bots
- ``tqdm.contrib.telegram``: Posts to `Telegram <https://telegram.org>`__ bots
- ``tqdm.contrib.bells``: Automagically enables all optional features

* ``auto``, ``pandas``, ``discord``, ``telegram``
Expand Down
11 changes: 7 additions & 4 deletions README.rst
Expand Up @@ -140,7 +140,7 @@ Changelog
The list of all changes is available either on GitHub's Releases:
|GitHub-Status|, on the
`wiki <https://github.com/tqdm/tqdm/wiki/Releases>`__, or on the
`website <https://tqdm.github.io/releases/>`__.
`website <https://tqdm.github.io/releases>`__.


Usage
Expand Down Expand Up @@ -679,7 +679,10 @@ Submodules
"""`rich.progress` version."""
class tqdm.keras.TqdmCallback(keras.callbacks.Callback):
"""`keras` callback for epoch and batch progress."""
"""Keras callback for epoch and batch progress."""
class tqdm.dask.TqdmCallback(dask.callbacks.Callback):
"""Dask callback for task progress."""
``contrib``
Expand All @@ -689,8 +692,8 @@ The ``tqdm.contrib`` package also contains experimental modules:

- ``tqdm.contrib.itertools``: Thin wrappers around ``itertools``
- ``tqdm.contrib.concurrent``: Thin wrappers around ``concurrent.futures``
- ``tqdm.contrib.discord``: Posts to `Discord <https://discord.com/>`__ bots
- ``tqdm.contrib.telegram``: Posts to `Telegram <https://telegram.org/>`__ bots
- ``tqdm.contrib.discord``: Posts to `Discord <https://discord.com>`__ bots
- ``tqdm.contrib.telegram``: Posts to `Telegram <https://telegram.org>`__ bots
- ``tqdm.contrib.bells``: Automagically enables all optional features

* ``auto``, ``pandas``, ``discord``, ``telegram``
Expand Down
2 changes: 1 addition & 1 deletion benchmarks/README.md
Expand Up @@ -11,7 +11,7 @@ These benchmarks serve two purposes:
- [`progressbar2`](https://pypi.org/project/progressbar2)
- [`alive-progress`](https://pypi.org/project/alive-progress)

Performance graphs are available at <https://tqdm.github.io/tqdm/>
Performance graphs are available at <https://tqdm.github.io/tqdm>

## Running

Expand Down
10 changes: 7 additions & 3 deletions tqdm/dask.py
@@ -1,13 +1,17 @@
from __future__ import absolute_import
from .auto import tqdm as tqdm_auto

from functools import partial

from dask.callbacks import Callback

from .auto import tqdm as tqdm_auto

__author__ = {"github.com/": ["casperdcl"]}
__all__ = ['TqdmCallback']


class TqdmCallback(Callback):
"""`dask` callback for task progress"""
"""Dask callback for task progress."""
def __init__(self, start=None, pretask=None, tqdm_class=tqdm_auto,
**tqdm_kwargs):
"""
Expand All @@ -34,7 +38,7 @@ def _finish(self, *_, **__):
self.pbar.close()

def display(self):
"""displays in the current cell in Notebooks"""
"""Displays in the current cell in Notebooks."""
container = getattr(self.bar, 'container', None)
if container is None:
return
Expand Down
6 changes: 1 addition & 5 deletions tqdm/gui.py
Expand Up @@ -24,12 +24,8 @@


class tqdm_gui(std_tqdm): # pragma: no cover
"""
Experimental Matplotlib GUI version of tqdm!
"""

"""Experimental Matplotlib GUI version of tqdm!"""
# TODO: @classmethod: write() on GUI?

def __init__(self, *args, **kwargs):
from collections import deque

Expand Down
4 changes: 2 additions & 2 deletions tqdm/keras.py
Expand Up @@ -17,7 +17,7 @@


class TqdmCallback(keras.callbacks.Callback):
"""`keras` callback for epoch and batch progress"""
"""Keras callback for epoch and batch progress."""
@staticmethod
def bar2callback(bar, pop=None, delta=(lambda logs: 1)):
def callback(_, logs=None):
Expand Down Expand Up @@ -98,7 +98,7 @@ def on_train_end(self, *_, **__):
self.epoch_bar.close()

def display(self):
"""displays in the current cell in Notebooks"""
"""Displays in the current cell in Notebooks."""
container = getattr(self.epoch_bar, 'container', None)
if container is None:
return
Expand Down
6 changes: 1 addition & 5 deletions tqdm/rich.py
Expand Up @@ -74,12 +74,8 @@ def render(self, task):


class tqdm_rich(std_tqdm): # pragma: no cover
"""
Experimental rich.progress GUI version of tqdm!
"""

"""Experimental rich.progress GUI version of tqdm!"""
# TODO: @classmethod: write()?

def __init__(self, *args, **kwargs):
"""
This class accepts the following parameters *in addition* to
Expand Down

0 comments on commit 28823f4

Please sign in to comment.