revised layout documentation

deepcave/layouts/general.py

@@ -2,7 +2,7 @@
 """
 # GeneralLayout
 
-This module provides the General Layout class.
+This module provides the General Layout.
 
 It handles different callbacks of the layout.
 
@@ -77,7 +77,7 @@ def callback(
             dynamic_working_dirs: List[str],
         ):
             """
-            Change the working directory.
+            Register updates from inputs.
 
             Parameters
             ----------
@@ -361,7 +361,7 @@ def _callback_manage_groups(self) -> None:
 
         @app.callback(outputs, inputs)  # type: ignore
         def callback(group_names: List[str], all_run_paths, i):
-            """Update the groups."""
+            """Manage the groups."""
             # Abort on page load
             self._refresh_groups: bool
             if self._refresh_groups:
@@ -430,12 +430,12 @@ def get_converter_text(converters: List[Type[Run]]) -> html.Div:
         Parameters
         ----------
         converters : List[Type[Run]]
-            The converters to be put into text.
+            A list of the avaialble run converters.
 
         Returns
         -------
         html.Div
-            The text for the input converters.
+            The text with all the available converters.
         """
         converter_text = []
         for converter in converters:

deepcave/layouts/main.py

@@ -33,7 +33,7 @@ class MainLayout(Layout):
     """
     Define and provide the main layout.
 
-    It handles different callbacks of the layout.
+    Handle different callbacks of the layout.
 
     Properties
     ----------

deepcave/layouts/notification.py

@@ -5,9 +5,7 @@
 This module provides a notification layout.
 
 It utilizes Dash and provides utilities for displaying notifications.
-The here provided NotificationLayout class inherits from Layout.
 With a notification from the Notification module an alert component can be updated.
-It can be updated in content, color as well as visibility.
 Callbacks are registered and handled.
 
 ## Classes
@@ -30,14 +28,14 @@ class NotificationLayout(Layout):
     """
     Layout class for displaying notifications.
 
-    Extends Layout class, provides callback registering methods.
+    Provide callback registering methods.
     """
 
     def __init__(self) -> None:
         super().__init__()
 
     def register_callbacks(self) -> None:
-        """Register callback for updating notification alert."""
+        """Register callbacks for updating notification alert."""
 
         @app.callback(
             Output("alert", "children"),

deepcave/layouts/sidebar.py

@@ -2,7 +2,7 @@
 """
 # SidebarLayout
 
-This module defines a plugin to define and visualize the Sidebar Layout.
+This module defines layout for the sidebar.
 
 Callbacks are registered and handled.
 
@@ -133,7 +133,7 @@ def delete_job(n_clicks, job_ids):  # type: ignore
 
         @app.callback(output, Trigger("global-update", "n_intervals"))  # type: ignore
         def update_queue_info() -> List[Component]:
-            """Delete the information of the queue."""
+            """Update the information of the queue."""
             try:
                 all_jobs = [
                     queue.get_finished_jobs(),