Commit d206e0e5 authored by Martin Matějek's avatar Martin Matějek

Fix docstrings to conform to PEP 257

parent 1b5d7a23
......@@ -7,6 +7,7 @@ from .notification import Notification
class Api:
"""Public interface of module"""
def __init__(self, conf=None):
if conf: # override default config
config.load_config(conf)
......@@ -47,6 +48,7 @@ class Api:
def create(self, skel_id, **user_opts):
"""
Create new notification based on selected skeleton
Prefered method for creating notification with minimal knowledge of underlying layers
"""
# get pre-filled skeleton of class Notification
......
......@@ -9,6 +9,7 @@ from .notification import Notification
class NotificationStorage:
"""In-memory notification storage that serialize and deserialize them"""
def __init__(self, volatile_dir, persistent_dir):
# print("Constructing new NotifyStorage")
self.storage_dirs = {
......@@ -25,6 +26,7 @@ class NotificationStorage:
def store(self, n):
"""
Store in memory
serializate to disk
render fallback in default languages
"""
......
......@@ -7,6 +7,7 @@ from .notificationskeleton import NotificationSkeleton
class PluginStorage:
"""Storage for plugins"""
def __init__(self, plugin_dir):
# print("Constructing new PluginStorage")
self.plugin_dir = plugin_dir
......@@ -39,6 +40,7 @@ class PluginStorage:
def get_skeleton(self, skel_id):
"""
Return notification skeleton based on id
input param in form 'PluginName.skeletonid'
so it need to be parsed to get skel_id
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment