fix: numpydoc warnings (#1556)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: RobPasMue

doc/changelog.d/1556.fixed.md

@@ -0,0 +1 @@
+numpydoc warnings

doc/source/conf.py

@@ -84,12 +84,6 @@ def get_wheelhouse_assets_dictionary():
 def intersphinx_pyansys_geometry(switcher_version: str):
     """Auxiliary method to build the intersphinx mapping for PyAnsys Geometry.
 
-    Notes
-    -----
-    If the objects.inv file is not found whenever it is a release, the method
-    will default to the "dev" version. If the objects.inv file is not found
-    for the "dev" version, the method will return an empty string.
-
     Parameters
     ----------
     switcher_version : str
@@ -99,6 +93,12 @@ def intersphinx_pyansys_geometry(switcher_version: str):
     -------
     str
         The intersphinx mapping for PyAnsys Geometry.
+
+    Notes
+    -----
+    If the objects.inv file is not found whenever it is a release, the method
+    will default to the "dev" version. If the objects.inv file is not found
+    for the "dev" version, the method will return an empty string.
     """
     prefix = "https://geometry.docs.pyansys.com/version"
 
@@ -230,13 +230,22 @@ def intersphinx_pyansys_geometry(switcher_version: str):
     "GL10",  # reST directives {directives} must be followed by two colons
     "SS01",  # No summary found
     "SS02",  # Summary does not start with a capital letter
-    # "SS03", # Summary does not end with a period
+    "SS03",  # Summary does not end with a period
     "SS04",  # Summary contains heading whitespaces
     # "SS05", # Summary must start with infinitive verb, not third person
     "RT02",  # The first line of the Returns section should contain only the
     # type, unless multiple values are being returned"
 }
 
+# Ignoring numpydoc validation on built-in methods from Python
+numpydoc_validation_exclude = {
+    "add_note",
+    "isEnabledFor",
+    "validate",
+    "__cause__",
+    "__context__",
+}
+
 # static path
 html_static_path = ["_static"]
 

src/ansys/geometry/core/connection/docker_instance.py

@@ -115,15 +115,15 @@ class LocalDockerInstance:
     def docker_client() -> "DockerClient":
         """Get the initialized ``__DOCKER_CLIENT__`` object.
 
-        Notes
-        -----
-        The ``LocalDockerInstance`` class performs a lazy initialization of the
-        ``__DOCKER_CLIENT__`` class variable.
-
         Returns
         -------
         ~docker.client.DockerClient
             Initialized Docker client.
+
+        Notes
+        -----
+        The ``LocalDockerInstance`` class performs a lazy initialization of the
+        ``__DOCKER_CLIENT__`` class variable.
         """
         if not LocalDockerInstance.__DOCKER_CLIENT__:
             LocalDockerInstance.__DOCKER_CLIENT__ = DockerClient.from_env()
@@ -327,10 +327,6 @@ def existed_previously(self) -> bool:
 def get_geometry_container_type(instance: LocalDockerInstance) -> GeometryContainers | None:
     """Provide back the ``GeometryContainers`` value.
 
-    Notes
-    -----
-    This method returns the first hit on the available tags.
-
     Parameters
     ----------
     instance : LocalDockerInstance
@@ -341,6 +337,10 @@ def get_geometry_container_type(instance: LocalDockerInstance) -> GeometryContai
     GeometryContainers or None
         The GeometryContainer value corresponding to the previous image or None
         if not match.
+
+    Notes
+    -----
+    This method returns the first hit on the available tags.
     """
     for tag in instance.container.image.tags:
         for geom_services in GeometryContainers:

src/ansys/geometry/core/connection/launcher.py

@@ -550,6 +550,11 @@ def launch_modeler_with_geometry_service(
         Placeholder to prevent errors when passing additional arguments that
         are not compatible with this method.
 
+    Returns
+    -------
+    Modeler
+        Instance of the Geometry service.
+
     Raises
     ------
     ConnectionError
@@ -559,11 +564,6 @@ def launch_modeler_with_geometry_service(
         If there is not an Ansys product 24.1 version or later installed
         a SystemError will be raised.
 
-    Returns
-    -------
-    Modeler
-        Instance of the Geometry service.
-
     Examples
     --------
     Starting a geometry service with the default parameters and getting back a ``Modeler``
@@ -683,6 +683,11 @@ def launch_modeler_with_discovery(
         Placeholder to prevent errors when passing additional arguments that
         are not compatible with this method.
 
+    Returns
+    -------
+    Modeler
+        Instance of the Geometry service.
+
     Raises
     ------
     ConnectionError
@@ -692,11 +697,6 @@ def launch_modeler_with_discovery(
         or if a specific product's version is requested but not installed locally then
         a SystemError will be raised.
 
-    Returns
-    -------
-    Modeler
-        Instance of the Geometry service.
-
     Examples
     --------
     Starting an Ansys Discovery session with the default parameters and getting back a ``Modeler``
@@ -810,6 +810,11 @@ def launch_modeler_with_spaceclaim(
         Placeholder to prevent errors when passing additional arguments that
         are not compatible with this method.
 
+    Returns
+    -------
+    Modeler
+        Instance of the Geometry service.
+
     Raises
     ------
     ConnectionError
@@ -819,11 +824,6 @@ def launch_modeler_with_spaceclaim(
         or if a specific product's version is requested but not installed locally then
         a SystemError will be raised.
 
-    Returns
-    -------
-    Modeler
-        Instance of the Geometry service.
-
     Examples
     --------
     Starting an Ansys SpaceClaim session with the default parameters and get back a ``Modeler``

src/ansys/geometry/core/connection/product_instance.py

@@ -237,6 +237,11 @@ def prepare_and_start_backend(
     logs_folder : str, optional
         DEPRECATED. Use ``server_logs_folder`` instead.
 
+    Returns
+    -------
+    Modeler
+        Instance of the Geometry service.
+
     Raises
     ------
     ConnectionError
@@ -245,11 +250,6 @@ def prepare_and_start_backend(
         If there is not an Ansys product 24.1 version or later installed
         or if a specific product's version is requested but not installed locally then
         a SystemError will be raised.
-
-    Returns
-    -------
-    Modeler
-        Instance of the Geometry service.
     """
     from ansys.geometry.core.modeler import Modeler
 
@@ -464,10 +464,6 @@ def _manifest_path_provider(
 def __start_program(args: list[str], local_env: dict[str, str]) -> subprocess.Popen:
     """Start the program.
 
-    Notes
-    -----
-    The path is the first item of the ``args`` array argument.
-
     Parameters
     ----------
     args : list[str]
@@ -480,6 +476,10 @@ def __start_program(args: list[str], local_env: dict[str, str]) -> subprocess.Po
     -------
     subprocess.Popen
         The subprocess object.
+
+    Notes
+    -----
+    The path is the first item of the ``args`` array argument.
     """
     # private method and controlled input by library - excluding bandit check.
     return subprocess.Popen(  # nosec B603