Migrate Vale version (#281)

.github/workflows/ci_cd.yml

@@ -35,7 +35,7 @@ jobs:
       - uses: ansys/actions/doc-style@v6
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          vale-version: "2.29.6"
+          vale-version: "3.4.1"
 
   wheelhouse:
     name: "Wheelhouse and smoke tests"

.pre-commit-config.yaml

@@ -23,9 +23,10 @@ repos:
     exclude: "examples/"
 
 - repo: https://github.com/codespell-project/codespell
-  rev: v2.2.2
+  rev: v2.2.6
   hooks:
   - id: codespell
+    args: ["--ignore-words", "doc/styles/config/vocabularies/ANSYS/accept.txt"]
 
 - repo: https://github.com/pycqa/pydocstyle
   rev: 6.3.0

doc/.vale.ini

@@ -26,3 +26,5 @@ Vocab = ANSYS
 
 # Apply the following styles
 BasedOnStyles = Vale, Google
+TokenIgnores = :py:(?:class|meth|const|attr|mod):`.*`
+Vale.Terms = NO

doc/source/api/node_types.rst

@@ -1,5 +1,5 @@
-NodeTypes
-=========
+Node types
+==========
 .. currentmodule:: ansys.optislang.core.node_types
 
 .. toctree::

doc/source/api/node_types/parametric_systems.rst

@@ -1,4 +1,4 @@
-Parametric Systems
+Parametric systems
 ==================
 .. currentmodule:: ansys.optislang.core.node_types
 

doc/source/user_guide/create_workflow.rst

@@ -28,7 +28,7 @@ with types of most of the available nodes are declared in
 Type of the created node can be also created manually using
 :py:class:`NodeType <ansys.optislang.core.node_types.NodeType>` if constant is not available.
 Code below shows value of constant 
-:py:const:`Sensitivity <ansys.optislang.core.node_types.Sensitivity>` from snippet above:
+:py:const:`Sensitivity <ansys.optislang.core.node_types.Sensitivity>` from the preceding snippet:
 
 .. code:: python
 

doc/source/user_guide/functions.rst

@@ -21,7 +21,7 @@ Within the context of the :py:class:`Application <ansys.optislang.core.applicati
 class instance, there is further
 property :py:attr:`project <ansys.optislang.core.application.Application.project>`, 
 which holds an instance of the :py:class:`Project <ansys.optislang.core.project.Project>` class
-(if any project is loaded). This instance groups functionality to get project information
+(if any project is loaded). This instance groups features to get project information
 and execute operations on the active project.
 
 .. code:: python

doc/source/user_guide/launch.rst

@@ -3,7 +3,7 @@
 =============================
 OptiSLang instance management
 =============================
-You use the :class:`Optislang <ansys.optislang.core.optislang.Optislang>`
+You use the :py:class:`Optislang <ansys.optislang.core.optislang.Optislang>`
 class to launch optiSLang as a server and to control and query optiSLang projects.
 You can either launch optiSLang locally or connect to a remote optiSLang instance.
 
@@ -164,7 +164,7 @@ initialized with the ``shutdown_on_finished`` parameter set to ``False``.
 
 * To shut down the optiSLang server, use both the
    :py:meth:`shutdown() <ansys.optislang.core.optislang.Optislang.shutdown>` and
-   :py;meth:`dispose() <ansys.optislang.core.optislang.Optislang.dispose>` methods: 
+   :py:meth:`dispose() <ansys.optislang.core.optislang.Optislang.dispose>` methods: 
 
    .. code:: python
 

doc/styles/.gitignore

@@ -1,4 +1,4 @@
 *
-!Vocab
-!Vocab/**
+!config
+!config/**
 !.gitignore

doc/styles/Vocab/ANSYS/accept.txt → doc/styles/config/vocabularies/ANSYS/accept.txt

@@ -2,7 +2,10 @@ optiSLang
 OptiSLang
 Optislang
 optislang
+optiSLang TCP
 PyOptiSLang
 osl
 Pythonic
-(?!)ansys
+Ansys
+design_flow
+integration_plugins

src/ansys/optislang/core/tcp/osl_server.py

@@ -3487,7 +3487,7 @@ def reset(self, actor_uid: Optional[str] = None, hid: Optional[str] = None):
         Parameters
         ----------
         actor_uid: Optional[str], optional
-            Actor uid entry. A Hirearchical ID (hid) is required. By default ``None``.
+            Actor uid entry. A Hierarchical ID (hid) is required. By default ``None``.
         hid: Optional[str], optional
             Hid entry. The actor uid is required. By default ``None``.
 

src/ansys/optislang/core/tcp/server_commands.py

@@ -1168,7 +1168,7 @@ def reset(
     Parameters
     ----------
     actor_uid: Optional[str], optional
-        Actor uid entry. A Hirearchical ID (hid) is required. By default ``None``.
+        Actor uid entry. A Hierarchical ID (hid) is required. By default ``None``.
     hid: Optional[str], optional
         Hid entry. The actor uid is required. By default ``None``.
     password : Optional[str], optional
@@ -1180,7 +1180,7 @@ def reset(
         JSON string of ``reset`` command.
     """
     if actor_uid and hid is None:
-        raise ValueError("The Hirearchical ID (hid) is required.")
+        raise ValueError("The Hierarchical ID (hid) is required.")
     elif actor_uid is None and hid:
         raise ValueError("The actor uid is required.")
     return _to_json(
@@ -1196,7 +1196,7 @@ def restart(
     Parameters
     ----------
     actor_uid: Optional[str], optional
-        Actor uid entry. A Hirearchical ID (hid) is required. By default ``None``.
+        Actor uid entry. A Hierarchical ID (hid) is required. By default ``None``.
     hid: Optional[str], optional
         Hid entry. The actor uid is required. By default ``None``.
     password : Optional[str], optional
@@ -1208,7 +1208,7 @@ def restart(
         JSON string of ``restart`` command.
     """
     if actor_uid and hid is None:
-        raise ValueError("The Hirearchical ID (hid) is required.")
+        raise ValueError("The Hierarchical ID (hid) is required.")
     elif actor_uid is None and hid:
         raise ValueError("The actor uid is required.")
     return _to_json(
@@ -1772,7 +1772,7 @@ def start(
     Parameters
     ----------
     actor_uid: Optional[str], optional
-        Actor uid entry. A Hirearchical ID (hid) is required. By default ``None``.
+        Actor uid entry. A Hierarchical ID (hid) is required. By default ``None``.
     hid: Optional[str], optional
         Hid entry. The actor uid is required. By default ``None``.
     password : Optional[str], optional
@@ -1784,7 +1784,7 @@ def start(
         JSON string of ``start`` command.
     """
     if actor_uid and hid is None:
-        raise ValueError("The Hirearchical ID (hid) is required.")
+        raise ValueError("The Hierarchical ID (hid) is required.")
     elif actor_uid is None and hid:
         raise ValueError("The actor uid is required.")
 
@@ -1801,7 +1801,7 @@ def stop(
     Parameters
     ----------
     actor_uid: Optional[str], optional
-        Actor uid entry. A Hirearchical ID (hid) is required. By default ``None``.
+        Actor uid entry. A Hierarchical ID (hid) is required. By default ``None``.
     hid: Optional[str], optional
         Hid entry. The actor uid is required. By default ``None``.
     password : Optional[str], optional
@@ -1813,7 +1813,7 @@ def stop(
         JSON string of ``stop`` command.
     """
     if actor_uid and hid is None:
-        raise ValueError("The Hirearchical ID (hid) is required.")
+        raise ValueError("The Hierarchical ID (hid) is required.")
     elif actor_uid is None and hid:
         raise ValueError("The actor uid is required.")
 
@@ -1830,7 +1830,7 @@ def stop_gently(
     Parameters
     ----------
     actor_uid: Optional[str], optional
-        Actor uid entry. A Hirearchical ID (hid) is required. By default ``None``.
+        Actor uid entry. A Hierarchical ID (hid) is required. By default ``None``.
     hid: Optional[str], optional
         Hid entry. The actor uid is required. By default ``None``.
     password : Optional[str], optional
@@ -1842,7 +1842,7 @@ def stop_gently(
         JSON string of ``stop_gently`` command.
     """
     if actor_uid and hid is None:
-        raise ValueError("The Hirearchical ID (hid) is required.")
+        raise ValueError("The Hierarchical ID (hid) is required.")
     elif actor_uid is None and hid:
         raise ValueError("The actor uid is required.")
     return _to_json(