Ensure LLAPI docstrings consistent

Author: kzscisoft

simvue/api/objects/administrator/tenant.py

@@ -19,7 +19,32 @@
 
 
 class Tenant(SimvueObject):
-    """Class for interacting with a tenant instance on the server."""
+    """
+    Simvue Tenant
+    =============
+
+    This class is used to connect to/create tenant objects on the Simvue server,
+    any modification of instance attributes is mirrored on the remote object.
+
+    """
+
+    def __init__(self, identifier: str | None = None, **kwargs) -> None:
+        """Initialise a Tenant
+
+        If an identifier is provided a connection will be made to the
+        object matching the identifier on the target server.
+        Else a new Tenant will be created using arguments provided in kwargs.
+
+        **Assumes the current user is an Administrator of the system.**
+
+        Parameters
+        ----------
+        identifier : str, optional
+            the remote server unique id for the target folder
+        **kwargs : dict
+            any additional arguments to be passed to the object initialiser
+        """
+        super().__init__(identifier, **kwargs)
 
     @classmethod
     @pydantic.validate_call

simvue/api/objects/administrator/user.py

@@ -20,7 +20,32 @@
 
 
 class User(SimvueObject):
-    """Class for interacting with a user instance on the server."""
+    """
+    Simvue User
+    ===========
+
+    This class is used to connect to/create user objects on the Simvue server,
+    any modification of instance attributes is mirrored on the remote object.
+
+    """
+
+    def __init__(self, identifier: str | None = None, **kwargs) -> None:
+        """Initialise a User
+
+        If an identifier is provided a connection will be made to the
+        object matching the identifier on the target server.
+        Else a new User will be created using arguments provided in kwargs.
+
+        **Assumes the current user is an Administrator of the system.**
+
+        Parameters
+        ----------
+        identifier : str, optional
+            the remote server unique id for the target folder
+        **kwargs : dict
+            any additional arguments to be passed to the object initialiser
+        """
+        super().__init__(identifier, **kwargs)
 
     @classmethod
     @pydantic.validate_call

simvue/api/objects/alert/events.py

@@ -19,10 +19,29 @@
 
 
 class EventsAlert(AlertBase):
-    """Connect to an event-based alert either locally or on a server"""
+    """
+    Simvue Events Alert
+    ===================
+
+    This class is used to connect to/create event-based alert objects on the Simvue server,
+    any modification of EventsAlert instance attributes is mirrored on the remote object.
+
+    """
 
     def __init__(self, identifier: str | None = None, **kwargs) -> None:
-        """Initialise a connection to an event alert by identifier"""
+        """Initialise an Events Alert
+
+        If an identifier is provided a connection will be made to the
+        object matching the identifier on the target server.
+        Else a new EventsAlert instance will be created using arguments provided in kwargs.
+
+        Parameters
+        ----------
+        identifier : str, optional
+            the remote server unique id for the target folder
+        **kwargs : dict
+            any additional arguments to be passed to the object initialiser
+        """
         self.alert = EventAlertDefinition(self)
         super().__init__(identifier, **kwargs)
 

simvue/api/objects/alert/fetch.py

@@ -33,7 +33,23 @@ def check_column(cls, column: str) -> str:
 
 
 class Alert:
-    """Generic Simvue alert retrieval class"""
+    """
+    Simvue Alert
+    ============
+
+    Generic Simvue alert retrieval class.
+
+    """
+
+    def __init__(self, identifier: str | None = None, *args, **kwargs) -> None:
+        """Initialise an instance of generic alert retriever.
+
+        Parameters
+        ----------
+        identifier : str
+            identifier of alert object to retrieve
+        """
+        super().__init__(identifier=identifier, *args, **kwargs)
 
     @pydantic.validate_call()
     def __new__(cls, identifier: str, **kwargs) -> AlertType:

simvue/api/objects/alert/metrics.py

@@ -24,10 +24,29 @@
 
 
 class MetricsThresholdAlert(AlertBase):
-    """Class for connecting to/creating a local or remotely defined metric threshold alert"""
+    """
+    Simvue Metrics Threshold Alert
+    ==============================
+
+    This class is used to connect to/create metrics threshold alert objects on the Simvue server,
+    any modification of MetricsThresholdAlert instance attributes is mirrored on the remote object.
+
+    """
 
     def __init__(self, identifier: str | None = None, **kwargs) -> None:
-        """Connect to a local or remote threshold alert by identifier"""
+        """Initialise a Metrics Threshold Alert
+
+        If an identifier is provided a connection will be made to the
+        object matching the identifier on the target server.
+        Else a new MetricsThresholdAlert instance will be created using arguments provided in kwargs.
+
+        Parameters
+        ----------
+        identifier : str, optional
+            the remote server unique id for the target folder
+        **kwargs : dict
+            any additional arguments to be passed to the object initialiser
+        """
         self.alert = MetricThresholdAlertDefinition(self)
         super().__init__(identifier, **kwargs)
         self._local_only_args += [
@@ -117,10 +136,29 @@ def new(
 
 
 class MetricsRangeAlert(AlertBase):
-    """Class for connecting to/creating a local or remotely defined metric range alert"""
+    """
+    Simvue Metrics Range Alert
+    ==========================
+
+    This class is used to connect to/create metrics range alert objects on the Simvue server,
+    any modification of MetricsRangeAlert instance attributes is mirrored on the remote object.
+
+    """
 
     def __init__(self, identifier: str | None = None, **kwargs) -> None:
-        """Connect to a local or remote threshold alert by identifier"""
+        """Initialise a Metrics Range Alert
+
+        If an identifier is provided a connection will be made to the
+        object matching the identifier on the target server.
+        Else a new MetricsRangeAlert instance will be created using arguments provided in kwargs.
+
+        Parameters
+        ----------
+        identifier : str, optional
+            the remote server unique id for the target folder
+        **kwargs : dict
+            any additional arguments to be passed to the object initialiser
+        """
         self.alert = MetricRangeAlertDefinition(self)
         super().__init__(identifier, **kwargs)
         self._local_only_args += [

simvue/api/objects/alert/user.py

@@ -21,9 +21,29 @@
 
 
 class UserAlert(AlertBase):
-    """Connect to/create a user defined alert either locally or on server"""
+    """
+    Simvue User Alert
+    =================
+
+    This class is used to connect to/create user alert objects on the Simvue server,
+    any modification of UserAlert instance attributes is mirrored on the remote object.
+
+    """
 
     def __init__(self, identifier: str | None = None, **kwargs) -> None:
+        """Initialise a User Alert
+
+        If an identifier is provided a connection will be made to the
+        object matching the identifier on the target server.
+        Else a new UserAlert instance will be created using arguments provided in kwargs.
+
+        Parameters
+        ----------
+        identifier : str, optional
+            the remote server unique id for the target folder
+        **kwargs : dict
+            any additional arguments to be passed to the object initialiser
+        """
         super().__init__(identifier, **kwargs)
         self._local_status: dict[str, str | None] = kwargs.pop("status", {})
 

simvue/api/objects/artifact/fetch.py

@@ -28,7 +28,13 @@ def check_column(cls, column: str) -> str:
 
 
 class Artifact:
-    """Generic Simvue artifact retrieval class"""
+    """
+    Simvue Artifact
+    ===============
+
+    Generic Simvue artifact retrieval class.
+
+    """
 
     def __init__(self, identifier: str | None = None, *args, **kwargs) -> None:
         """Initialise an instance of generic artifact retriever.

simvue/api/objects/artifact/file.py

@@ -17,17 +17,30 @@
 
 
 class FileArtifact(ArtifactBase):
-    """File based artifact modification and creation class."""
+    """
+    Simvue File Artifact
+    ====================
+
+    This class is used to connect to/create file artifact objects on the Simvue server,
+    any modification of instance attributes is mirrored on the remote object.
+
+    """
 
     def __init__(
         self, identifier: str | None = None, _read_only: bool = True, **kwargs
     ) -> None:
-        """Initialise a new file artifact connection.
+        """Initialise a File Artifact
+
+        If an identifier is provided a connection will be made to the
+        object matching the identifier on the target server.
+        Else a new FileArtifact instance will be created using arguments provided in kwargs.
 
         Parameters
         ----------
         identifier : str, optional
-            the identifier of this object on the server.
+            the remote server unique id for the target folder
+        **kwargs : dict
+            any additional arguments to be passed to the object initialiser
         """
         super().__init__(identifier=identifier, _read_only=_read_only, **kwargs)
 

simvue/api/objects/artifact/object.py

@@ -15,17 +15,30 @@
 
 
 class ObjectArtifact(ArtifactBase):
-    """Object based artifact modification and creation class."""
+    """
+    Simvue Object Artifact
+    ======================
+
+    This class is used to connect to/create file object artifact objects on the Simvue server,
+    any modification of instance attributes is mirrored on the remote object.
+
+    """
 
     def __init__(
         self, identifier: str | None = None, _read_only: bool = True, **kwargs
     ) -> None:
-        """Initialise a new object artifact connection.
+        """Initialise a Object Artifact
+
+        If an identifier is provided a connection will be made to the
+        object matching the identifier on the target server.
+        Else a new ObjectArtifact instance will be created using arguments provided in kwargs.
 
         Parameters
         ----------
         identifier : str, optional
-            the identifier of this object on the server.
+            the remote server unique id for the target folder
+        **kwargs : dict
+            any additional arguments to be passed to the object initialiser
         """
         kwargs.pop("original_path", None)
         super().__init__(identifier, _read_only, original_path="", **kwargs)

simvue/api/objects/events.py

@@ -29,12 +29,22 @@
 
 
 class Events(SimvueObject):
+    """
+    Simvue Events
+    =============
+
+    This class is used to connect to/create events objects on the Simvue server,
+    any modification of instance attributes is mirrored on the remote object.
+
+    """
+
     def __init__(
         self,
         _read_only: bool = True,
         _local: bool = False,
         **kwargs,
     ) -> None:
+        """Initialise an Events object instance for creation/retrieval."""
         self._label = "event"
         super().__init__(_read_only=_read_only, _local=_local, **kwargs)
         self._run_id = self._staging.get("run")