rm stale references to global conf in doc

Author: amorison

stagpy/_helpers.py

@@ -18,12 +18,7 @@
 
 
 def walk(sdat: StagyyData, conf: Config) -> _StepsView:
-    """Return view on configured steps slice.
-
-    Other Parameters:
-        conf.core.snapshots: the slice of snapshots.
-        conf.core.timesteps: the slice of timesteps.
-    """
+    """Return view on configured steps slice."""
     if conf.core.timesteps:
         return sdat.steps[conf.core.timesteps]
     return sdat.snaps[conf.core.snapshots]

stagpy/args.py

@@ -1,4 +1,4 @@
-"""Parse command line arguments and update :attr:`stagpy.conf`."""
+"""Parse command line arguments."""
 
 from __future__ import annotations
 

stagpy/commands.py

@@ -22,11 +22,7 @@
 
 
 def info_cmd(conf: Config) -> None:
-    """Print basic information about StagYY run.
-
-    Other Parameters:
-        conf.info
-    """
+    """Print basic information about StagYY run."""
     sdat = stagyydata.StagyyData(conf.core.path)
     lsnap = sdat.snaps[-1]
     lstep = sdat.steps[-1]
@@ -174,11 +170,7 @@ def config_pp(subs: Iterable[str], conf: Config) -> None:
 
 
 def config_cmd(conf: Config) -> None:
-    """Configuration handling.
-
-    Other Parameters:
-        conf.config
-    """
+    """Configuration handling."""
     if conf.config.create:
         conf.default_().to_file_(CONFIG_LOCAL)
     else:

stagpy/rprof.py

@@ -92,12 +92,7 @@ def plot_grid(step: Step, conf: Optional[Config] = None) -> None:
 
 
 def cmd(conf: Config) -> None:
-    """Implementation of rprof subcommand.
-
-    Other Parameters:
-        conf.rprof
-        conf.core
-    """
+    """Implementation of rprof subcommand."""
     sdat = StagyyData(conf.core.path)
     view = _helpers.walk(sdat, conf)
 

stagpy/time_series.py

@@ -37,10 +37,6 @@ def plot_time_series(
     Args:
         sdat: a :class:`~stagpy.stagyydata.StagyyData` instance.
         names: time series names organized by figures, plots and subplots.
-
-    Other Parameters:
-        conf.time.tstart: the starting time.
-        conf.time.tend: the ending time.
     """
     if conf is None:
         conf = Config.default_()
@@ -125,12 +121,7 @@ def compstat(
 
 
 def cmd(conf: Config) -> None:
-    """Implementation of time subcommand.
-
-    Other Parameters:
-        conf.time
-        conf.core
-    """
+    """Implementation of time subcommand."""
     sdat = StagyyData(conf.core.path)
     if sdat.tseries is None:
         return