Skip to content

Commit

Permalink
Move docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
zpriddy committed Apr 16, 2020
1 parent 4d813c8 commit 2ea485f
Showing 1 changed file with 20 additions and 21 deletions.
41 changes: 20 additions & 21 deletions src/glados/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,34 +18,33 @@


class Glados:
"""Glados is the core of the GLaDOS package.
Parameters
----------
config_file
path to config file
plugins_folder
path to plugins folder
bots_config_dir
path to bots config folder
plugins_config_dir
path to plugin config folder.
Notes
-----
If ``config_file`` is passed in and the file has ``plugins_folder``,
``bots_config_dir``, ``plugins_config_dir`` in it , then the other
parameters are not required
"""

def __init__(
self,
config_file: Optional[str] = None,
plugins_folder: Optional[str] = None,
bots_config_dir: Optional[str] = None,
plugins_config_dir: Optional[str] = None,
):
"""Glados is the core of the GLaDOS package.
Parameters
----------
config_file
path to config file
plugins_folder
path to plugins folder
bots_config_dir
path to bots config folder
plugins_config_dir
path to plugin config folder.
Notes
-----
If ``config_file`` is passed in and the file has ``plugins_folder``,
``bots_config_dir``, ``plugins_config_dir`` in it , then the other
parameters are not required
"""

self.router = GladosRouter()
self.plugins = list() # type: List[GladosPlugin]
Expand Down

0 comments on commit 2ea485f

Please sign in to comment.