Added docs for config plugin

platypush/event/__init__.py

@@ -16,14 +16,9 @@ class EventGenerator(object):
         self._event_handlers = {}  # Event type => callback map
 
     def fire_event(self, event):
-        """
-        Fires an event (instance of :class:`platypush.message.event.Event` or a
-        subclass) to the internal bus and triggers any handler callback
-        associated to the event type or any of its super-classes.
-
-        :param event: Event to fire
-        :type event: :class:`platypush.message.event.Event` or a subclass
-        """
+        # Fires an event (instance of :class:`platypush.message.event.Event` or a
+        # subclass) to the internal bus and triggers any handler callback
+        # associated to the event type or any of its super-classes.
 
         def hndl_thread(handler):
             handler(event)

platypush/plugins/config/__init__.py

@@ -12,30 +12,51 @@ class ConfigPlugin(Plugin):
 
     @action
     def get(self) -> dict:
+        """
+        Get the current configuration.
+        """
         return Config.get()
 
     @action
     def get_plugins(self) -> dict:
+        """
+        Get the configured plugins.
+        """
         return Config.get_plugins()
 
     @action
     def get_backends(self) -> dict:
+        """
+        Get the configured backends.
+        """
         return Config.get_backends()
 
     @action
     def get_procedures(self) -> dict:
+        """
+        Get the configured procedures.
+        """
         return json.loads(json.dumps(Config.get_procedures(), cls=Message.Encoder))
 
     @action
     def dashboards(self) -> dict:
+        """
+        Get the configured dashboards.
+        """
         return Config.get_dashboards()
 
     @action
     def get_dashboard(self, name: str) -> str:
+        """
+        Get a dashboard configuration by name.
+        """
         return Config.get_dashboard(name)
 
     @action
     def get_device_id(self) -> str:
+        """
+        Get the configured ``device_id``.
+        """
         return Config.get('device_id')