tyler.durden/powerline
1
0
Fork 0
mirror of https://github.com/powerline/powerline.git synced 2025-07-31 01:35:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation

Browse Source
This commit is contained in:
ZyX 2014-08-15 19:41:15 +04:00
parent 4a8b81e68b
commit 33562ab4b8
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
powerline/__init__.py
View File

@ -280,7 +280,7 @@ class Powerline(object):
:param str renderer_module: :param str renderer_module:
Overrides renderer module (defaults to ``ext``). Should be the name of Overrides renderer module (defaults to ``ext``). Should be the name of
the package imported like this: ``powerline.renderers.{render_module}``. the package imported like this: ``powerline.renderers.{render_module}``.
If this parameter contains a dot, ``powerline.renderers.`` is not If this parameter contains a dot ``powerline.renderers.`` is not
prepended. There is also a special case for renderers defined in prepended. There is also a special case for renderers defined in
toplevel modules: ``foo.`` (note: dot at the end) tries to get renderer toplevel modules: ``foo.`` (note: dot at the end) tries to get renderer
from module ``foo`` (because ``foo`` (without dot) tries to get renderer from module ``foo`` (because ``foo`` (without dot) tries to get renderer
@ -288,16 +288,17 @@ class Powerline(object):
dot) variant is used ``renderer_module`` will be dot) variant is used ``renderer_module`` will be
``powerline.renderers.{ext}{renderer_module}``. ``powerline.renderers.{ext}{renderer_module}``.
:param bool run_once: :param bool run_once:
Determines whether .renderer.render() method will be run only once Determines whether :py:meth:`render` method will be run only once
during python session. during python session.
:param Logger logger: :param Logger logger:
If present, no new logger will be created and this logger will be used. If present no new logger will be created and the provided logger will be
used.
:param bool use_daemon_threads: :param bool use_daemon_threads:
Use daemon threads for. When creating threads make them daemon ones.
:param Event shutdown_event: :param Event shutdown_event:
Use this Event as shutdown_event. Use this Event as shutdown_event instead of creating new event.
:param ConfigLoader config_loader: :param ConfigLoader config_loader:
Class that manages (re)loading of configuration. Instance of the class that manages (re)loading of the configuration.
''' '''
def __init__(self, def __init__(self,