reformat /docstrings - ruff

Author: d-w-moore

irods/access.py

@@ -126,11 +126,12 @@ def copy(self, decanonicalize=False, implied_zone=''):
         Create a copy of the object, possibly in a normalized form.
 
         Args:
-            decanonicalize: Whether to modify to access_name field to a more human-readable (1/True) or more standard (-1) form.
-                If the former, then a more organic style is favored, i.e. "read" and "write".  If the latter, the new access_name
-                will be more machine-friendly for operators __lt__ (for sorting) and __eq__ (for equivalence or use with 'in').
-            implied_zone: If a nonzero-length name, compare this against the zone_name field of the old object, and if they match,
-                force the zone_name to zero-length in the new object.
+            decanonicalize: Whether to modify to access_name field to a more human-readable (1/True)
+                or more standard (-1) form.  If the former, then a more organic style is favored, i.e.
+                "read" and "write".  If the latter, the new access_name will be more machine-friendly
+                for operators __lt__ (for sorting) and __eq__ (for equivalence or use with 'in').
+            implied_zone: If a nonzero-length name, compare this against the zone_name field of the
+                old object, and if they match, force the zone_name to zero-length in the new object.
 
         Returns:
             A copy of the invoking object, normalized if requested.
@@ -159,11 +160,12 @@ def copy(self, decanonicalize=False, implied_zone=''):
             pass
         else:
             msg = "Improper value for 'decanonicalize' parameter"
-            raise RuntimerError(msg)
+            raise RuntimeError(msg)
 
         other.access_name = access_name
 
-        # Useful if we wish to force an explicitly specified local zone to an implicit zone spec in the copy, for equality testing:
+        # Useful if we wish to force an explicitly specified local zone to an implicit zone spec in the copy, for
+        # equality testing:
         if '' != implied_zone == other.user_zone:
             other.user_zone = ''
 
@@ -177,13 +179,25 @@ def __repr__(self):
 
 
 class iRODSAccess(_iRODSAccess_base, metaclass=_Access_LookupMeta):
+    """
+    This class represents an ACL in iRODS and functions as a data container
+    to convey information to the iRODS server (in the `set` call) and back again to the client
+    again (in the `get` call.)
+    """
     def __init__(self, access_name, path, user_name="", user_zone="", user_type=None):
         self.codes = self.__class__.codes
         self.strings = self.__class__.strings
         super().__init__(access_name, path, user_name, user_zone, user_type)
 
 
 class ACLOperation(iRODSAccess):
+    """
+    Similar to its base class iRODSAccess, this class represents an ACL to be set on an object.
+    but this class is the counterpart used for the atomic ACLs api.  It differs from its base
+    class in that it has no field to store a logical object path.  (For an atomic API call, i
+    here is always a single logical path to which all operations apply, meaning that it is
+    appropriate to conveyed that in a location separate from the operations themsevles.)
+    """
     def __init__(self, access_name: str, user_name: str = "", user_zone: str = ""):
         super().__init__(
             access_name=access_name,
@@ -251,7 +265,7 @@ def __init__(self, *args, **kwargs):
             )
             super().__init__(*args,**kwargs)
 
-_deprecated_names = {'_iRODSAccess_pre_4_3_0':_deprecated._iRODSAccess_pre_4_3_0}
+_deprecated_names = {'_iRODSAccess_pre_4_3_0': _deprecated._iRODSAccess_pre_4_3_0}
 
 def __getattr__(name):
     if name in _deprecated_names: