Edits based on

Author: PipKat

README.rst

@@ -43,9 +43,9 @@ The documentation has these sections:
 - `Getting started <https://ansys.tools.docs.pyansys.com/version/stable/getting_started/index.html>`_: Learn
   how to install Ansys Common Tools in user mode.
 - `User guide <https://ansys.tools.docs.pyansys.com/version/stable/user_guide/index.html>`_: Understand key
-  concepts for implementing its set of tools in your workflows.
+  concepts for implementing its tools in your workflows.
 - `API reference <https://ansys.tools.docs.pyansys.com/version/stable/api/index.html>`_: Understand how to
-  use Python to interact programmatically with its set of tools.
+  use Python to interact programmatically with its tools.
 - `Contribute <https://ansys.tools.docs.pyansys.com/version/stable/contributing.html>`_: Learn how to
   contribute to the Ansys Common Tools codebase or documentation.
 

doc/.vale.ini

@@ -25,13 +25,9 @@ Vocab = ANSYS
 [*.{md,rst}]
 
 # Apply the following styles
-[*.{rst}]
-
-# Inline roles are ignored
-TokenIgnores = (:.*:`.*`)
-
 BasedOnStyles = Vale, Google
 Vale.Terms = NO
 Google.Headings = NO
-SkippedScopes = script, style, pre, figure, code-block, literal-block
 
+# Inline roles are ignored
+TokenIgnores = (:.*:`.*`)

doc/source/index.rst

@@ -20,7 +20,7 @@ Ansys Common Tools provides a collection of tools for the PyAnsys ecosystem.
         :link: user_guide/index
         :link-type: doc
 
-        Understand key concepts for implementing its set of tools
+        Understand key concepts for implementing its tools
         in your workflows.
 
 
@@ -30,7 +30,7 @@ Ansys Common Tools provides a collection of tools for the PyAnsys ecosystem.
         :link-type: doc
 
         Understand how to use Python to interact programmatically with
-        its set of tools.
+        its tools.
 
     .. grid-item-card:: Contribute :material-regular:`group`
         :padding: 2 2 2 2

doc/source/user_guide/ansys_downloader.rst

@@ -3,7 +3,7 @@
 Ansys example downloader
 ========================
 
-Use the Ansys example downloader to download examples from a PyAnsys library. After you import this tool, specify the filename, directory, and local path for the file to download:
+Use the Ansys example downloader to download an example from a PyAnsys library. Import this tool and then specify the filename, directory, and local path for the file to download:
 
 .. code:: pycon
 

doc/source/user_guide/ansys_exceptions.rst

@@ -3,9 +3,11 @@
 Ansys exceptions
 ================
 
-Use the Ansys exceptions tool to gracefully catch and handle exceptions that might occur when using Ansys tools, thereby providing a better user experience.
+Ansys exceptions are a set of predefined error-handling classes designed to help developers identify, catch, and handle errors that might occur when using Ansys tools. These exceptions provide a structured way to manage errors, ensuring that your programs can gracefully recover from unexpected issues and provide meaningful feedback to users.
 
-After importing this tool, use the base :class:`AnsysError <ansys.tools.common.exceptions.AnsysError>` class to catch and handle exceptions related to Ansys tools, extending with your exceptions or using them directly in your programs:
+By using Ansys exceptions, you can improve the robustness and maintainability of your code. They allow you to differentiate between various types of errors, such as invalid input types or logical inconsistencies, and handle them appropriately.
+
+You can import exception classes and use the predefined exceptions directly in your programs:
 
 .. code:: pycon
 
@@ -18,3 +20,15 @@ After importing this tool, use the base :class:`AnsysError <ansys.tools.common.e
    AnsysTypeError: An invalid type was provided.
    >>> raise AnsysLogicError("A logic error occurred in Ansys tools.")
    AnsysLogicError: A logic error occurred in Ansys tools.
+
+You can also extend the base exception class to define your own custom exceptions. This allows you to create error types specific to your needs:
+
+```python
+class CustomError(AnsysError):
+    """A custom exception for specific error handling."""
+
+    pass
+
+
+raise CustomError("This is a custom error message.")
+```

doc/source/user_guide/ansys_tools_path.rst

@@ -3,7 +3,7 @@
 Ansys path tool
 ===============
 
-Use the Ansys path tool to find the path of the latest local Ansys installation. After importing this tool, call the :func:`find_ansys <ansys.tools.common.path.find_ansys>` function to return the installation path:
+Use the Ansys path tool to find the path of the latest local Ansys installation. Importing this tool and then call the :func:`find_ansys <ansys.tools.common.path.find_ansys>` function to return the installation path:
 
 .. code:: pycon
 

doc/source/user_guide/index.rst

@@ -4,12 +4,10 @@
 User guide
 ==========
 
-This section explains key concepts for implementing its set of tools in your
-PyAnsys workflows. You can use these tools in your examples as well as integrate Ansys Common Tools into your own code.
+This section explains key concepts for implementing the tools in Ansys Common Tools in your PyAnsys workflows. You can use these tools in your examples as well as integrate them into your own code.
 
 .. important::
-   This library only supports the last two major versions of Python. Usage with older
-   versions might or might not work.
+   Ansys Common Tools only supports the last two major versions of Python. Usage with older versions might not work.
 
 
 
@@ -20,14 +18,14 @@ PyAnsys workflows. You can use these tools in your examples as well as integrate
         :link: ansys_tools_path
         :link-type: doc
 
-        Learn how to use Ansys path tool.
+        Learn how to use the Ansys path tool.
 
     .. grid-item-card:: Ansys example downloader
         :padding: 2 2 2 2
         :link: ansys_downloader
         :link-type: doc
 
-        Learn how to use the example downloader tool.
+        Learn how to use the example downloader.
 
     .. grid-item-card:: Ansys exceptions
         :padding: 2 2 2 2

doc/source/user_guide/launcher/cli.rst

@@ -3,10 +3,10 @@
 Command-line interface
 ======================
 
-You use the ``ansys-launcher`` command-line interface to edit the default
-launch configuration.
+Use the ``ansys-launcher`` command-line interface to edit default
+launch configurations.
 
-Configuration options for products are defined by each product plugin.
+Each product plugin defines configuration options for its products.
 
 .. click:: ansys.tools.common.launcher._cli:cli
     :prog: ansys-launcher

doc/source/user_guide/launcher/index.rst

@@ -1,7 +1,7 @@
 Local product launcher
 ----------------------
 
-Use the local product launcher rather than launch functions implemented by various PyAnsys libraries. These pages provide an overview and describes how to use it.
+Use the local product launcher rather than the launch functions implemented by various PyAnsys libraries. These pages provide an overview and describe how to use the local product launcher:
 
 - :ref:`rationale`: Provides a high-level overview of the problem that the
   local product launcher solves.

doc/source/user_guide/launcher/plugin_creation.rst

@@ -3,10 +3,9 @@
 Launcher plugin creation
 ------------------------
 
-This page explains how to create a plugin for the Local Product Launcher. The plugin
-in the example launches Ansys Composite PrepPost (ACP) as a subprocess.
+This page explains how to create a plugin for the local product launcher. The plugin in the example launches Ansys Composite PrepPost (ACP) as a subprocess.
 
-The Local Product Launcher defines the interface that a plugin must satisfy in the :mod:`.interface` module.
+The local product launcher defines the interface that a plugin must satisfy in the :mod:`.interface` module.
 
 .. note::
 
@@ -88,14 +87,13 @@ there's quite a lot going on in this code, descriptions of each part are provide
             return {"main": self._url}
 
 
-The launcher class inherits from ``LauncherProtocol[LauncherConfig]``. This isn't a requirement, but it means a type checker like `mypy <https://mypy.readthedocs.io>`_ can verify that the :class:`.LauncherProtocol` interface is fulfilled.
+The launcher class inherits from ``LauncherProtocol[LauncherConfig]``. This isn't a requirement, but it means a type checker like `Mypy <https://mypy.readthedocs.io>`_ can verify that the :class:`.LauncherProtocol` interface is fulfilled.
 
 Next, setting ``CONFIG_MODEL = DirectLauncherConfig`` connects the launcher to the configuration class.
 
 The subsequent line, ``SERVER_SPEC = {"main": ServerType.GRPC}``, defines which kind of servers the
-product starts. Here, there's only a single server, which is accessible via gRPC. The keys in this
-dictionary can be chosen arbitrarily, but they should be consistent across the launcher implementation.
-Ideally, you use the key to convey some meaning. For example, ``"main"`` could refer to the main interface
+product starts. Here, there's only a single server, which is accessible via gRPC. The keys in this dictionary can be chosen arbitrarily, but they should be consistent across the launcher implementation.
+Ideally, use the key to convey some meaning. For example, ``"main"`` could refer to the main interface
 to your product and ``file_transfer`` could refer to an additional service for file upload and download.
 
 The ``__init__`` method must accept exactly one keyword-only argument, ``config``, which contains the
@@ -109,7 +107,7 @@ For the ``_url`` and ``_process`` attributes, only the type is declared for the
         self._url: str
         self._process: subprocess.Popen[str]
 
-The core of the launcher implementation is in the ``start()`` and ``stop()`` methods:
+The core of the launcher implementation is in the ``start`` and ``stop`` methods:
 
 .. code:: python
 
@@ -126,11 +124,11 @@ The core of the launcher implementation is in the ``start()`` and ``stop()`` met
             text=True,
         )
 
-This :meth:`start()<.LauncherProtocol.start>` method selects an available port using the
-:func:`.find_free_ports` function. It then starts the server as a subprocess. Note that here, the server output is simply discarded. In a real launcher, the option to redirect it (for example to a file) should be added.
+The :meth:`start<.LauncherProtocol.start>` method selects an available port using the
+:func:`.find_free_ports` function. It then starts the server as a subprocess. Note that here, the server output is simply discarded. In a real launcher, you should add the option to redirect it (for example to a file).
 The ``_url`` attribute keeps track of the URL and port that the server should be accessible on.
 
-The :meth:`start()<.LauncherProtocol.stop>` method terminates the subprocess:
+The :meth:`start<.LauncherProtocol.stop>` method terminates the subprocess:
 
 .. code:: python
 
@@ -143,12 +141,12 @@ The :meth:`start()<.LauncherProtocol.stop>` method terminates the subprocess:
             self._process.wait()
 
 If your product is prone to ignoring ``SIGTERM``, you might want to add a timeout to the
-:py:meth:`.wait() <subprocess.Popen.wait>` method and retry with the
-:py:meth:`.kill() <subprocess.Popen.kill>` method instead of the
-:py:meth:`.terminate() <subprocess.Popen.terminate>` method.
+:py:meth:`.wait <subprocess.Popen.wait>` method and retry with the
+:py:meth:`.kill <subprocess.Popen.kill>` method instead of the
+:py:meth:`.terminate <subprocess.Popen.terminate>` method.
 
 Next, you must provide a way to verify that the product has successfully launched. This is implemented
-in the :meth:`check <.LauncherProtocol.check>`. Because the server implements gRPC health checking, the
+in the :meth:`check <.LauncherProtocol.check>` method. Because the server implements gRPC health checking, the
 :func:`.check_grpc_health` helper can be used for this purpose:
 
 .. code:: python
@@ -158,7 +156,7 @@ in the :meth:`check <.LauncherProtocol.check>`. Because the server implements gR
         return check_grpc_health(channel=channel, timeout=timeout)
 
 
-Finally, the ``_url`` attribute stored in the :meth:`start() <.LauncherProtocol.start>` method must
+Finally, the ``_url`` attribute stored in the :meth:`start <.LauncherProtocol.start>` method must
 be made available in the :attr:`urls <.LauncherProtocol.urls>` property:
 
 .. code:: python
@@ -174,19 +172,17 @@ Note that the return value for the ``urls`` property should adhere to the schema
 Register entrypoint
 '''''''''''''''''''
 
-Having defined all the necessary components for a Local Product Launcher plugin, you can now register the
-plugin, which makes it available. You do this through the Python `entrypoints <https://packaging.python.org/specifications/entry-points/>`_
-mechanism.
+Having defined all the necessary components for a local product launcher plugin, you can now register the
+plugin, which makes it available. You do this through the Python `entrypoints mechanism <https://packaging.python.org/specifications/entry-points/>`_.
 
-You define the entrypoint in your package's build configuration. The exact syntax depends on which
-packaging tool you use:
+You define the entrypoint in your package's build configuration. The exact syntax depends on which packaging tool you use:
 
 .. .. grid:: 1
 ..     :gutter: 3
 
 .. tab-set::
 
-    .. tab-item:: setuptools
+    .. tab-item:: Setuptools
 
         Setuptools can accept its configuration in one of three ways. Choose the one that applies to your project:
 
@@ -221,9 +217,9 @@ packaging tool you use:
             )
 
 
-        For more information, see the `setuptools documentation <https://setuptools.pypa.io/en/latest/userguide/entry_point.html#entry-points-for-plugins>`_.
+        For more information, see the `Entry Points for Plugins <https://setuptools.pypa.io/en/latest/userguide/entry_point.html#entry-points-for-plugins>`_ in the Setuptools documentation.
 
-    .. tab-item:: flit
+    .. tab-item:: Flit
 
         In a ``pyproject.toml`` file:
 
@@ -232,9 +228,9 @@ packaging tool you use:
             [project.entry-points."ansys.tools.local_product_launcher.launcher"]
             "ACP.direct" = "<your.module.name>:DirectLauncher"
 
-        For more information, see the `flit documentation <https://flit.pypa.io/en/stable/pyproject_toml.html#pyproject-project-entrypoints>`_.
+        For more information, see the `Entry points sections <https://flit.pypa.io/en/stable/pyproject_toml.html#pyproject-project-entrypoints>`_ in the Flit documentation.
 
-    .. tab-item:: poetry
+    .. tab-item:: Poetry
 
         In a ``pyproject.toml`` file:
 
@@ -243,39 +239,35 @@ packaging tool you use:
             [tool.poetry.plugins."ansys.tools.local_product_launcher.launcher"]
             "ACP.direct" = "<your.module.name>:DirectLauncher"
 
-        For more information, see the `poetry documentation <https://python-poetry.org/docs/pyproject#plugins>`_.
+        For more information, see the `plugins <https://python-poetry.org/docs/pyproject#plugins>`_ in the Poetry documentation.
 
-In all cases, ``ansys.tools.local_product_launcher.launcher`` is an identifier specifying that the entrypoint defines a Local Product Launcher plugin. It must be kept the same.
+In all cases, ``ansys.tools.local_product_launcher.launcher`` is an identifier specifying that the entrypoint defines a local product launcher plugin. It must be kept the same.
 
 The entrypoint itself has two parts:
 
-- The entrypoint name ``ACP.direct`` consists of two parts: ``ACP`` is the product name, and
-  ``direct`` is the launch mode identifier. The name must be of this format and contain exactly
-  one dot ``.`` separating the two parts.
-- The entrypoint value ``<your.module.name>:DirectLauncher`` defines where the launcher
-  implementation is located. In other words, it must load the launcher class:
+- The entrypoint name ``ACP.direct`` consists of two parts: ``ACP`` is the product name, and ``direct`` is the launch mode identifier. The name must be of this format and contain exactly one dot ``.`` separating the two parts.
+- The entrypoint value ``<your.module.name>:DirectLauncher`` defines where the launcher implementation is located. In other words, it must load the launcher class:
 
   .. code::
 
       from <your.module.name> import DirectLauncher
 
 
-For the entrypoints to update, you must re-install your package (even if it was installed with ``pip install -e``).
+For the entrypoints to update, you must re-install your package (even if it was installed with the ``pip install -e`` command).
 
 Add command-line default and description
 ''''''''''''''''''''''''''''''''''''''''
 
-With the three preceding parts, you've successfully created a Local Product Launcher plugin. :octicon:`rocket`
+With the three preceding parts, you've successfully created a local product launcher plugin. :octicon:`rocket`
 
-You can now improve the usability of the command line by adding a default and description to the configuration class.
+You can now improve the usability of the command line by adding a default and a description to the configuration class.
 
 To do so, edit the ``DirectLaunchConfig`` class, using the :py:func:`dataclasses.field` function to enrich
 the ``binary_path``:
 
 * The default value is specified as the ``default`` argument.
 * The description is given in the ``metadata`` dictionary, using the special key :py:obj:`METADATA_KEY_DOC <.interface.METADATA_KEY_DOC>`.
 
-
 .. code:: python
 
     import os
@@ -309,23 +301,18 @@ the ``binary_path``:
 For the default value, use the :py:func:`get_available_ansys_installations <path.get_available_ansys_installations>`
 helper to find the Ansys installation directory.
 
-Now, when running ``ansys-launcher configure ACP direct``, users can see and accept the default
-value if they want.
+Now, when running ``ansys-launcher configure ACP direct``, users can see and accept the default value if they want.
 
 .. note::
 
-    If the default value is ``None``, it is converted to the string ``default`` for the
-    command-line interface. This allows implementing more complicated default behaviors
-    that may not be expressible when the command-line interface is run.
+    If the default value is ``None``, it is converted to the string ``default`` for command-line interface. This allows implementing more complicated default behaviors that may not be expressible when the command-line interface is run.
 
 Add a fallback launch mode
 ''''''''''''''''''''''''''
 
-If you want to provide a fallback launch mode that can be used without any configuration, you can add
-an entrypoint with the special name ``<product>.__fallback__``.
+If you want to provide a fallback launch mode that can be used without any configuration, you can add an entrypoint with the special name ``<product>.__fallback__``.
 
-For example, if you wanted the ``DirectLauncher`` to be the fallback for ACP, you could add this
-entrypoint:
+For example, to make ``DirectLauncher`` the fallback for ACP, add this entry point:
 
 .. code:: toml