update documentation

mdb/mdb.py

@@ -9,12 +9,12 @@
 
 @click.group()
 def main() -> None:
-    """``mdb`` is comprised of two sub-commands ``attach`` and  ``launch``.
+    """mdb is comprised of two sub-commands [attach] and [launch].
 
     They both need to be run in order to start a debug session.
 
-    * Firstly, use the ``launch`` command to start the ``gdb`` debug processes.
-    * Then, use ``attach`` to connect ``mdb`` to the debug processes.
+    * Firstly, use the launch command to start the mdb debug processes.
+    * Then, use attach to connect mdb to the debug processes.
 
     See documentation of the respective subcommands for more information.
     """

mdb/mdb_attach.py

@@ -80,6 +80,12 @@ def attach(
     exec_script: click.File,
     plot_lib: str,
 ) -> None:
+    """Attach to mdb debug server.
+
+    Example:
+
+    $ mdb attach -n 8
+    """
     # debug all ranks if "select" is not set
     if select is None:
         select = f"0-{ranks - 1}"

mdb/mdb_launch.py

@@ -84,6 +84,12 @@ def launch(
     auto_restart: bool,
     args: tuple[str] | list[str],
 ) -> None:
+    """Launch mdb debug server.
+
+    Example:
+
+    $ mdb launch -n 8 --auto-restart ./simple-mpi.exe
+    """
     args = list(args)
 
     # debug all ranks if "select" is not set