doc: modified more files.

Author: moe-ad

src/ansys/dpf/core/operator_specification.py

@@ -21,9 +21,7 @@
 # SOFTWARE.
 
 """
-.. _ref_operator_specification:
-
-Operator Specification
+Operator Specification.
 
 The OperatorSpecification Provides a documentation for each Operator
 """
@@ -43,7 +41,7 @@
 
 
 class PinSpecification:
-    """Documents an input or output pin of an Operator
+    """Documents an input or output pin of an Operator.
 
     Parameters
     ----------
@@ -99,7 +97,8 @@ def __init__(
 
     @property
     def type_names(self) -> list[str]:
-        """
+        """Return the list of accepted types.
+
         Returns
         -------
         list[str], list[type]
@@ -144,6 +143,7 @@ def _get_copy(other, changed_types) -> PinSpecification:
         )
 
     def __repr__(self):
+        """Provide more detail in the representation of the instance."""
         return "{class_name}({params})".format(
             class_name=self.__class__.__name__,
             params=", ".join(
@@ -154,11 +154,13 @@ def __repr__(self):
         )
 
     def __eq__(self, other):
+        """One instance is equal to the other if their string representation is the same."""
         return str(self) == str(other)
 
 
 class ConfigSpecification(dict):
-    """Dictionary of the available configuration options and their specification
+    """Dictionary of the available configuration options and their specification.
+
     (:class:`ansys.dpf.core.operator_specification.ConfigOptionSpec`)
     """
 
@@ -167,8 +169,9 @@ def __init__(self, *arg, **kw):
 
 
 class ConfigOptionSpec:
-    """Documentation of a configuration option available for a given
-     Operator (:class:`ansys.dpf.core.Operator`)
+    """Documentation of a configuration option available for a given Operator.
+    
+     (:class:`ansys.dpf.core.Operator`)
 
     Attributes
     ----------
@@ -207,6 +210,7 @@ def __init__(self, name: str, type_names: list, default_value_str: str, document
         self.document = document
 
     def __repr__(self):
+        """Provide more detail in the representation of the instance."""
         return "{class_name}({params})".format(
             class_name=self.__class__.__name__,
             params=", ".join(
@@ -217,25 +221,29 @@ def __repr__(self):
 
 
 class SpecificationBase:
+    """Interface description for the specification base class."""
+
     @property
     @abc.abstractmethod
     def description(self) -> Union[str, None]:
+        """To be implemented in the subclasses."""
         pass
 
     @property
     @abc.abstractmethod
     def inputs(self) -> dict:
+        """To be implemented in the subclasses."""
         pass
 
     @property
     @abc.abstractmethod
     def outputs(self) -> dict:
+        """To be implemented in the subclasses."""
         pass
 
 
 class Specification(SpecificationBase):
-    """Documents an Operator with its description (what the Operator does),
-    its inputs and outputs and some properties.
+    """Documents an Operator with its description (what the Operator does), its inputs and outputs and some properties.
 
     Examples
     --------
@@ -306,11 +314,14 @@ def __init__(
         self._config_specification = None
 
     def __str__(self):
+        """Provide more details in the string representation of the instance."""
         return "Description:\n" + str(self.description) + "\nProperties:\n" + str(self.properties)
 
     @property
     def properties(self) -> dict:
-        """Some additional properties of the Operator, like the category, the exposure,
+        """Additional properties of the Operator.
+        
+        Some additional properties of the Operator, like the category, the exposure,
         the scripting and user names, and the plugin
 
         Examples
@@ -338,7 +349,7 @@ def properties(self) -> dict:
 
     @property
     def description(self) -> str:
-        """Returns a description of the operation applied by the Operator
+        """Returns a description of the operation applied by the Operator.
 
         Returns
         -------
@@ -357,7 +368,7 @@ def description(self) -> str:
 
     @property
     def inputs(self) -> dict:
-        """Returns a dictionary mapping the input pin numbers to their ``PinSpecification``
+        """Returns a dictionary mapping the input pin numbers to their ``PinSpecification``.
 
         Returns
         -------
@@ -380,7 +391,7 @@ def inputs(self) -> dict:
 
     @property
     def outputs(self) -> dict:
-        """Returns a dictionary mapping the output pin numbers to their ``PinSpecification``
+        """Returns a dictionary mapping the output pin numbers to their ``PinSpecification``.
 
         Returns
         -------
@@ -441,7 +452,7 @@ def _fill_pins(self, binput, to_fill):
 
     @property
     def config_specification(self) -> ConfigSpecification:
-        """Documents the available configuration options supported by the Operator
+        """Documents the available configuration options supported by the Operator.
 
         Returns
         -------
@@ -471,6 +482,8 @@ def config_specification(self) -> ConfigSpecification:
 
 
 class CustomConfigOptionSpec(ConfigOptionSpec):
+    """Custom documentation of a configuration option available for a given operator."""
+
     def __init__(self, option_name: str, default_value, document: str):
         type_names = [mapping_types.map_types_to_cpp[type(default_value).__name__]]
         super().__init__(
@@ -482,12 +495,16 @@ def __init__(self, option_name: str, default_value, document: str):
 
 
 class Exposures:
+    """Exposures class."""
+
     private = "private"
     public = "public"
     hidden = "hidden"
 
 
 class Categories:
+    """Categories class."""
+
     result = "result"
     math = "math"
     mesh = "mesh"
@@ -558,26 +575,77 @@ def __init__(
         )
 
     def __repr__(self):
+        """
+        Return a string representation of the SpecificationProperties instance.
+
+        Returns
+        -------
+        str
+            A string representation of the instance, including all attributes
+            and their values.
+        """
         keys = sorted(self.__dict__)
         items = ("{}={!r}".format(k, self.__dict__[k]) for k in keys)
         return "{}({})".format(type(self).__name__, ", ".join(items))
 
     def __setitem__(self, key, value):
+        """
+        Set the value of a specified attribute.
+
+        If a specification is defined, the value is also updated in the 
+        operator specification.
+
+        Parameters
+        ----------
+        key : str
+            The name of the attribute to set.
+        value : any
+            The value to assign to the attribute.
+        """
         if self._spec is not None:
             if value is not None:
                 self._spec._api.operator_specification_set_property(self._spec, key, value)
                 self._spec._properties = None
         setattr(self, key, value)
 
     def __getitem__(self, item: str):
+        """
+        Get the value of a specified attribute.
+
+        Parameters
+        ----------
+        item : str
+            The name of the attribute to retrieve.
+
+        Returns
+        -------
+        any
+            The value of the specified attribute.
+        """       
         return getattr(self, item)
 
     def __eq__(self, other):
+        """
+        Check if two SpecificationProperties instances are equal.
+
+        Parameters
+        ----------
+        other : SpecificationProperties
+            The other instance to compare against.
+
+        Returns
+        -------
+        bool
+            True if the two instances have the same attributes and values,
+            False otherwise.
+        """
         return self.__dict__ == other.__dict__
 
 
 class CustomSpecification(Specification):
-    """Allows to create an Operator Specification with its description (what the Operator does),
+    """Create an operator specification with its description.
+    
+    Allows to create an Operator Specification with its description (what the Operator does),
     its inputs and outputs and some properties.
     Inherits from Specification (which has only getters) to implement setters.
 
@@ -631,7 +699,7 @@ def __init__(self, description=None, server=None):
     @property
     @version_requires("4.0")
     def description(self) -> str:
-        """Description of the operation applied by the Operator"""
+        """Description of the operation applied by the Operator."""
         return super().description
 
     @description.setter
@@ -641,7 +709,7 @@ def description(self, value) -> str:
     @property
     @version_requires("4.0")
     def inputs(self) -> dict:
-        """Dictionary mapping the input pin numbers to their ``PinSpecification``
+        """Dictionary mapping the input pin numbers to their ``PinSpecification``.
 
         Returns
         -------
@@ -684,7 +752,7 @@ def inputs(self, val: dict):
     @property
     @version_requires("4.0")
     def outputs(self) -> dict:
-        """Returns a dictionary mapping the output pin numbers to their ``PinSpecification``
+        """Returns a dictionary mapping the output pin numbers to their ``PinSpecification``.
 
         Returns
         -------
@@ -727,7 +795,7 @@ def outputs(self, val: dict):
     @property
     @version_requires("4.0")
     def config_specification(self) -> ConfigSpecification:
-        """Documents the available configuration options supported by the Operator
+        """Documents the available configuration options supported by the Operator.
 
         Returns
         -------
@@ -767,7 +835,9 @@ def config_specification(self, val: list):
     @property
     @version_requires("4.0")
     def properties(self) -> SpecificationProperties:
-        """Returns some additional properties of the Operator, like the category, the exposure,
+        """Return additional properties of the Operator.
+        
+        Returns some additional properties of the Operator, like the category, the exposure,
         the scripting and user names and the plugin
         """
         return SpecificationProperties(**super().properties, spec=self)

src/ansys/dpf/core/outputs.py

@@ -20,12 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-"""
-.. _ref_outputs:
-
-Outputs
-
-"""
+"""Outputs."""
 
 from ansys.dpf.core.mapping_types import map_types_to_python
 from ansys.dpf.core.common import types
@@ -36,6 +31,7 @@
 class Output:
     """
     Intermediate class internally instantiated by the :class:`ansys.dpf.core.dpf_operator.Operator`.
+
     Used to evaluate and get outputs of the Operator.
 
     Examples
@@ -59,7 +55,7 @@ def __init__(self, spec, pin, operator):
             self._python_expected_types.append(map_types_to_python[cpp_type])
 
     def get_data(self):
-        """Retrieves the output of the operator."""
+        """Retrieve the output of the operator."""
         type_output = self._spec.type_names[0]
 
         if type_output == "abstract_meshed_region":
@@ -101,9 +97,18 @@ def get_data(self):
         return derived_types[0][0](output)
 
     def __call__(self):
+        """Allow instances of the class to be callable for data retrieval purposes."""
         return self.get_data()
 
     def __str__(self):
+        """
+        Return a string representation of the Output instance.
+
+        Returns
+        -------
+        str
+            A string representation of the instance.
+        """
         docstr = self._spec.name
         if self._spec.optional:
             docstr += " (optional)"
@@ -116,7 +121,8 @@ def __str__(self):
 
 
 class _Outputs:
-    """
+    """Base class subclassed by the :class:`ansys.dpf.core.outputs.Output` class.
+
     Parameters
     ----------
     dict_outputs : dict
@@ -185,6 +191,7 @@ def _modify_output_spec_with_one_type(output_spec, type):
 class Outputs(_Outputs):
     """
     Intermediate class internally instantiated by the :class:`ansys.dpf.core.dpf_operator.Operator`.
+
     Used to list the available :class:`ansys.dpf.core.outputs.Output` s of the Operator.
 
     Examples