Fix docstrings in base.filing and base.tyming

src/hio/base/filing.py

@@ -28,10 +28,8 @@ class Filer(hioing.Mixin):
         HeadDirPath (str): default abs dir path head such as "/usr/local/var"
         TailDirPath (str): default rel dir path tail when using head
         CleanTailDirPath (str): default rel dir path tail when creating clean
-        AltHeadDirPath (str): default alt dir path head such as  "~"
-                              as fallback when desired head not permitted.
-        AltTailDirPath (str): default alt rel dir path tail as fallback
-                              when using alt head.
+        AltHeadDirPath (str): default alt dir path head such as "~" (fallback).
+        AltTailDirPath (str): default alt rel dir path tail (alt head).
         AltCleanTailDirPath (str): default alt rel path tail when creating clean
         TempHeadDir (str): default temp abs dir path head such as "/tmp"
         TempPrefix (str): default rel dir path prefix when using temp head
@@ -46,16 +44,12 @@ class Filer(hioing.Mixin):
         headDirPath (str): head directory path
         path (str | None):  full directory or file path once created else None
         perm (int):  octal OS permissions for path directory and/or file
-        filed (bool): True means .path ends in file.
-                       False means .path ends in directory
-        extensioned (bool): When not filed:
-                                True means ensure .path ends with fext
-                                False means do not ensure .path ends with fext
+        filed (bool): True means .path ends in file. False means .path ends in directory
+        extensioned (bool): When not filed, True means ensure .path ends with fext.
         mode (str): file open mode if filed
         fext (str): file extension if filed
         file (File | None): File instance when filed and created.
-        opened (bool): True means directory created and if filed then file
-                is opened. False otherwise
+        opened (bool): True means directory created and if filed then file is opened. False otherwise
 
     Properties:
         name (str): unique path component used in directory or file path name
@@ -64,7 +58,8 @@ class Filer(hioing.Mixin):
         _name (str): unique name for .name property
 
 
-    File/Directory Creation Mode Notes:
+    File/Directory Creation Mode Notes::
+
         .Perm provides default restricted access permissions to directory and/or files
         stat.S_ISVTX | stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
         0o1700==960
@@ -551,7 +546,7 @@ def openFiler(cls=None, name="test", temp=True, reopen=True, clear=False, **kwa)
                           False means do not remove directory upon close when reopening
     See filing.Filer for other keyword parameter passthroughs
 
-    Usage:
+    Usage::
 
     with openFiler(name="bob") as filer:
 

src/hio/base/tyming.py

@@ -109,11 +109,11 @@ class Tymee(hioing.Mixin):
     Attributes:
 
     Properties:
-        tyme (float | None):  relative cycle time of associated Tymist which is
+        tyme (float or None):  relative cycle time of associated Tymist which is
             provided by calling .tymth function wrapper closure which is obtained
             from Tymist.tymen().
             None means not assigned yet.
-        tymth (Callable | None): function wrapper closure returned by
+        tymth (Callable or None): function wrapper closure returned by
             Tymist.tymen() method. When .tymth is called it returns associated
             Tymist.tyme. Provides injected dependency on Tymist cycle tyme base.
             None means not assigned yet.
@@ -143,7 +143,7 @@ def tyme(self):
         tyme property getter, get ._tyme
         .tyme is float cycle time in seconds
         Returns:
-            tyme (float | None): tyme from self.tymth() when wound else None
+            tyme (float or None): tyme from self.tymth() when wound else None
         """
         return self._tymth() if self._tymth else None
 
@@ -179,37 +179,17 @@ def wind(self, tymth):
 class Tymer(Tymee):
     """
     Tymer class to measure cycle time given by .tyme property of Tymist instance.
-    tyme is relative cycle time either artificial or real
+    tyme is relative cycle time either artificial or real.
 
-    Inherited Attributes
+    Inherited attributes and properties are documented on Tymee.
 
-    Attributes:
-
-    Inherited Properties:
-        tyme is float relative cycle time of associated Tymist .tyme obtained
-            via injected .tymth function wrapper closure.
-        tymth is function wrapper closure returned by Tymist .tymeth() method.
-            When .tymth is called it returns associated Tymist .tyme.
-            .tymth provides injected dependency on Tymist tyme base.
-
-    Properties:
-        duration (float): tyme duration in seconds from ._start to ._stop
-        elaspsed (float): tyme elasped in seconds  since ._start
-        remaining (float): tyme remaining in seconds  until ._stop
-        expired  (bool): True if expired, False otherwise, i.e. .tyme >= ._stop
-
-    Inherited Methods:
-        .wind is injects ._tymth dependency
-
-    Methods:
-        .start() = start tymer at current .tyme
-        .restart() = restart tymer at last ._stop so no time lost
+        Properties:
+        - duration (float): tyme duration in seconds from ._start to ._stop.
+        - elapsed (float): tyme elapsed in seconds since ._start.
+        - remaining (float): tyme remaining in seconds until ._stop.
+        - expired (bool): True if expired (.tyme >= ._stop).
 
-    Hidden:
-        _tymth (closure): injected function wrapper closure returned by .tymen() of
-            associated Tymist instance that returns Tymist .tyme. when called.
-        _start (float):  start tyme in seconds
-        _stop (float):  stop tyme in seconds
+        Hidden attributes: _tymth, _start, _stop.
 
     """
     Duration = 0.0  # default duration when not provided
@@ -270,8 +250,8 @@ def expired(self):
     def wind(self, tymth):
         """
         Inject new ._tymist and any other bundled tymee references
-        Update any dependencies on a change in ._tymist:
-            starts over itself at new ._tymists time
+        Update any dependencies on a change in ._tymist by restarting at the
+        new ._tymist time.
         """
         super(Tymer, self).wind(tymth)
         self.start()
@@ -280,8 +260,8 @@ def wind(self, tymth):
     def start(self, duration=None, start=None):
         """
         Starts Tymer of duration secs at start time start secs.
-            If duration not provided then uses current duration
-            If start not provided then starts at current .tyme
+        If duration not provided then uses current duration.
+        If start not provided then starts at current .tyme.
         """
         # remember current duration when duration not provided
         duration = float(duration) if duration is not None else self.duration
@@ -297,6 +277,3 @@ def restart(self, duration=None):
         No time lost. Useful to extend Tymer so no time lost
         """
         return self.start(duration=duration, start=self._stop)
-
-
-