improve cmd() docstrings, simplify cli._sub()

Author: amorison

src/stagpy/cli.py

@@ -4,7 +4,6 @@
 
 import importlib.resources as imlr
 import typing
-from inspect import isfunction
 from pathlib import Path
 from types import MappingProxyType
 
@@ -26,13 +25,12 @@
 from .config import Config
 
 if typing.TYPE_CHECKING:
-    from typing import Any, Callable
+    from typing import Callable
 
 
-def _sub(cmd: Any, *sections: str) -> Subcmd:
+def _sub(cmd: Callable[[Config], None], *sections: str) -> Subcmd:
     """Build Subcmd instance."""
-    cmd_func = cmd if isfunction(cmd) else cmd.cmd
-    return Subcmd(baredoc(cmd), *sections, func=cmd_func)
+    return Subcmd(baredoc(cmd), *sections, func=cmd)
 
 
 def _bare_cmd(conf: Config) -> None:
@@ -59,11 +57,11 @@ def _load_mplstyle(conf: Config) -> None:
 SUB_CMDS = MappingProxyType(
     {
         "common_": Subcmd(doc_module, "common", func=_bare_cmd),
-        "field": _sub(field, "core", "plot", "scaling"),
-        "rprof": _sub(rprof, "core", "plot", "scaling"),
-        "time": _sub(time_series, "core", "plot", "scaling"),
-        "refstate": _sub(refstate, "core", "plot"),
-        "plates": _sub(plates, "core", "plot", "scaling"),
+        "field": _sub(field.cmd, "core", "plot", "scaling"),
+        "rprof": _sub(rprof.cmd, "core", "plot", "scaling"),
+        "time": _sub(time_series.cmd, "core", "plot", "scaling"),
+        "refstate": _sub(refstate.cmd, "core", "plot"),
+        "plates": _sub(plates.cmd, "core", "plot", "scaling"),
         "info": _sub(commands.info_cmd, "core", "scaling"),
         "var": _sub(commands.var_cmd),
         "version": _sub(commands.version_cmd),

src/stagpy/field.py

@@ -364,7 +364,10 @@ def _findminmax(view: StepsView, sovs: Iterable[str]) -> dict[str, tuple[float,
 
 
 def cmd(conf: Config) -> None:
-    """Implementation of field subcommand."""
+    """Plot scalar and vector fields.
+
+    This is the implementation of the `field` subcommand.
+    """
     sdat = _sdat_from_conf(conf.core)
     view = _helpers.walk(sdat, conf)
     # no more than two fields in a subplot

src/stagpy/plates.py

@@ -403,7 +403,10 @@ def plot_scalar_field(
 
 
 def cmd(conf: Config) -> None:
-    """Implementation of plates subcommand."""
+    """Plate analysis.
+
+    This is the implementation of the `plates` subcommand.
+    """
     sdat = _sdat_from_conf(conf.core)
     view = _helpers.walk(sdat, conf)
 

src/stagpy/refstate.py

@@ -42,7 +42,10 @@ def plot_ref(sdat: StagyyData, var: str, conf: Config | None = None) -> None:
 
 
 def cmd(conf: Config) -> None:
-    """Implementation of refstate subcommand."""
+    """Plot reference state profiles.
+
+    This is the implementation of the `refstate` subcommand.
+    """
     sdat = _sdat_from_conf(conf.core)
 
     for var in conf.refstate.plot:

src/stagpy/rprof.py

@@ -96,7 +96,10 @@ def plot_grid(step: Step, conf: Config | None = None) -> None:
 
 
 def cmd(conf: Config) -> None:
-    """Implementation of rprof subcommand."""
+    """Plot radial profiles.
+
+    This is the implementation of the `rprof` subcommand.
+    """
     sdat = _sdat_from_conf(conf.core)
     view = _helpers.walk(sdat, conf)
 

src/stagpy/time_series.py

@@ -123,7 +123,10 @@ def compstat(
 
 
 def cmd(conf: Config) -> None:
-    """Implementation of time subcommand."""
+    """Plot time series.
+
+    This is the implementation of the `time` subcommand.
+    """
     sdat = _sdat_from_conf(conf.core)
     if conf.time.fraction is not None:
         if not 0 < conf.time.fraction <= 1: