Skip to content

Commit

Permalink
Update docs to fix issues with type checking IDEs (PyCharm)
Browse files Browse the repository at this point in the history
  • Loading branch information
bunjiboys authored and avylove committed Jun 25, 2020
1 parent 7481082 commit 7431b33
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions enlighten/_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ class Manager(object):
below. (Default: :py:data:`None`)
enabled(bool): Status (Default: True)
no_resize(bool): Disable resizing support
kwargs(dict): Any additional :py:term:`keyword arguments<keyword argument>`
kwargs(Dict[str, Any]): Any additional :py:term:`keyword arguments<keyword argument>`
will be used as default values when :py:meth:`counter` is called.
Manager class for outputting progress bars to streams attached to TTYs
Expand Down Expand Up @@ -130,7 +130,7 @@ def counter(self, position=None, **kwargs):
Args:
position(int): Line number counting from the bottom of the screen
autorefresh(bool): Refresh this counter when other bars are drawn
kwargs(dict): Any additional :py:term:`keyword arguments<keyword argument>`
kwargs(Dict[str, Any]): Any additional :py:term:`keyword arguments<keyword argument>`
are passed to :py:class:`Counter`
Returns:
Expand Down Expand Up @@ -159,7 +159,7 @@ def status_bar(self, *args, **kwargs):
Args:
position(int): Line number counting from the bottom of the screen
autorefresh(bool): Refresh this counter when other bars are drawn
kwargs(dict): Any additional :py:term:`keyword arguments<keyword argument>`
kwargs(Dict[str, Any]): Any additional :py:term:`keyword arguments<keyword argument>`
are passed to :py:class:`StatusBar`
Returns:
Expand All @@ -185,7 +185,7 @@ def _add_counter(self, counter_class, *args, **kwargs):
Args:
counter_class(:py:class:`PrintableCounter`): Class to instantiate
position(int): Line number counting from the bottom of the screen
kwargs(dict): Any additional :py:term:`keyword arguments<keyword argument>`
kwargs(Dict[str, Any]): Any additional :py:term:`keyword arguments<keyword argument>`
are passed to :py:class:`Counter`
Returns:
Expand Down Expand Up @@ -512,7 +512,7 @@ def get_manager(stream=None, counterclass=Counter, **kwargs):
stream(:py:term:`file object`): Output stream. If :py:data:`None`,
defaults to :py:data:`sys.stdout`
counter_class(:py:term:`class`): Progress bar class (Default: :py:class:`Counter`)
kwargs(dict): Any additional :py:term:`keyword arguments<keyword argument>`
kwargs(Dict[str, Any]): Any additional :py:term:`keyword arguments<keyword argument>`
will passed to the manager class.
Returns:
Expand Down

0 comments on commit 7431b33

Please sign in to comment.