ansys · dipinknair · Feb 21, 2024 · Feb 21, 2024 · Feb 21, 2024 · Feb 21, 2024
@@ -55,6 +55,7 @@ jobs:
         uses: ansys/actions/doc-style@v5
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
+          vale-version: "3.1.0"
 
   smoke-tests:
     name: Build and Smoke tests

@@ -13,7 +13,8 @@ This document follows the conventions laid out in [Keep a CHANGELOG](https://kee
 - Add logo for dark theme ([#601](https://github.com/ansys/pymechanical/pull/601))
 
 ### Changed
- - Update ``pre-commit`` ([#610](https://github.com/ansys/pymechanical/pull/610))
+- Update ``pre-commit`` ([#610](https://github.com/ansys/pymechanical/pull/610))
+- Update vale version to 3.1.0 ([#613](https://github.com/ansys/pymechanical/pull/613))
 
 ### Dependencies
 - Bump `plotly` from 5.18.0 to 5.19.0 ([#605](https://github.com/ansys/pymechanical/pull/605))

@@ -25,6 +25,7 @@ Vocab = ANSYS
 # Apply the following styles
 [*.{rst}]
 BasedOnStyles = Vale, Google
+Vale.Terms = NO
 
 # By default, `class` and `func` are ignored
 TokenIgnores = (:class:`.*`|:func:`.*`)

@@ -1,4 +1,4 @@
 *
-!Vocab
-!Vocab/**
+!vocabularies
+!vocabularies/**
 !.gitignore
diff --git a/doc/source/user_guide_scripting/index.rst b/doc/source/user_guide_scripting/index.rst
       for obj in Tree:
           obj.Name = obj.Name + " suffix"

 API entry points
 ----------------

 When running scripts inside of Mechanical, you can access the APIs via these entry points:
diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst
 .. _ref_index_api:

 =============
 API reference
 =============

 This section describes PyMechanical classes, functions, and attributes.
diff --git a/doc/source/api/pool.rst b/doc/source/api/pool.rst
 .. _ref_pool_api:

 Local Mechanical Pool
 =====================

 This section describes how to work with a local pool of Mechanical instances.

 .. currentmodule:: ansys.mechanical.core

 LocalMechanicalPool Class
 -------------------------

 :class:`~ansys.mechanical.core.pool.LocalMechanicalPool` provides functionality for working with a local pool of Mechanical instances.
diff --git a/doc/source/user_guide_session/server-launcher.rst b/doc/source/user_guide_session/server-launcher.rst
    add_switch = f"-featureflags mechanical.material.import;"
    mechanical = launch_mechanical(additional_switches=add_switch)

 API reference
 ~~~~~~~~~~~~~
 For more information on controlling how Mechanical launches locally, see the
 :func:`launch_mechanical() <ansys.mechanical.core.launch_mechanical>` method.
diff --git a/doc/source/user_guide_session/pool.rst b/doc/source/user_guide_session/pool.rst
     'result8',
     'result9']

 API reference
 -------------

 For more information, see :ref:`ref_pool_api`.
diff --git a/doc/source/getting_started/faq.rst b/doc/source/getting_started/faq.rst
 for batch mode. You can use the first two tools from either Ansys Workbench or from
 standalone Mechanical.

 ACT in Mechanical
 ^^^^^^^^^^^^^^^^^

 In Mechanical, ACT is a customization framework. When specific features are missing,
diff --git a/doc/source/getting_started/running_mechanical.rst b/doc/source/getting_started/running_mechanical.rst
 section of the Ansys Help, where you can view or download the *Ansys, Inc. Licensing Guide* for
 comprehensive licensing information.

 VPN issues
 ----------

 Sometimes, Mechanical has issues starting when VPN software is running. For more information,
diff --git a/doc/source/user_guide_embedding/libraries.rst b/doc/source/user_guide_embedding/libraries.rst

 .. note::

    This is an experimental feature. Some of these libraries will not work.

 Most of Mechanical's scripting APIs are implemented in C#. However, there are a small number
 of Python modules that are distributed with the installation of Mechanical that can be used
diff --git a/doc/source/getting_started/wsl.rst b/doc/source/getting_started/wsl.rst
 .. _ref_guide_wsl:

 Windows Subsystem for Linux
 ===========================

 This page explains how you use a PyAnsys library, more specifically PyMechanical,
 **********************


 IP addresses
 ------------

 The IP address ``127.0.0.1`` specified in `Run Mechanical on a local Docker image`_ is
 full path to the ``options`` file.


 IP addresses in WSL and the Windows host
 ****************************************

 **Theory:** You should be able to access the Windows host using the IP address
	for obj in Tree:
	obj.Name = obj.Name + " suffix"

	API entry points
Check warning on line 75 in doc/source/user_guide_scripting/index.rst GitHub Actions / vale [vale] doc/source/user_guide_scripting/index.rst#L75 `[Google.Headings] 'API entry points' should use sentence-style capitalization.` Raw output `{"message": "[Google.Headings] 'API entry points' should use sentence-style capitalization.", "location": {"path": "doc/source/user_guide_scripting/index.rst", "range": {"start": {"line": 75, "column": 1}}}, "severity": "WARNING"}`
	----------------

	When running scripts inside of Mechanical, you can access the APIs via these entry points:
	.. _ref_index_api:

	=============
	API reference
Check warning on line 4 in doc/source/api/index.rst GitHub Actions / vale [vale] doc/source/api/index.rst#L4 `[Google.Headings] 'API reference' should use sentence-style capitalization.` Raw output `{"message": "[Google.Headings] 'API reference' should use sentence-style capitalization.", "location": {"path": "doc/source/api/index.rst", "range": {"start": {"line": 4, "column": 1}}}, "severity": "WARNING"}`
	=============

	This section describes PyMechanical classes, functions, and attributes.
	.. _ref_pool_api:

	Local Mechanical Pool
Check warning on line 3 in doc/source/api/pool.rst GitHub Actions / vale [vale] doc/source/api/pool.rst#L3 `[Google.Headings] 'Local Mechanical Pool' should use sentence-style capitalization.` Raw output `{"message": "[Google.Headings] 'Local Mechanical Pool' should use sentence-style capitalization.", "location": {"path": "doc/source/api/pool.rst", "range": {"start": {"line": 3, "column": 1}}}, "severity": "WARNING"}`
	=====================

	This section describes how to work with a local pool of Mechanical instances.

	.. currentmodule:: ansys.mechanical.core

	LocalMechanicalPool Class
Check warning on line 10 in doc/source/api/pool.rst GitHub Actions / vale [vale] doc/source/api/pool.rst#L10 `[Google.Headings] 'LocalMechanicalPool Class' should use sentence-style capitalization.` Raw output `{"message": "[Google.Headings] 'LocalMechanicalPool Class' should use sentence-style capitalization.", "location": {"path": "doc/source/api/pool.rst", "range": {"start": {"line": 10, "column": 1}}}, "severity": "WARNING"}`
	-------------------------

	:class:`~ansys.mechanical.core.pool.LocalMechanicalPool` provides functionality for working with a local pool of Mechanical instances.
	add_switch = f"-featureflags mechanical.material.import;"
	mechanical = launch_mechanical(additional_switches=add_switch)

	API reference
Check warning on line 80 in doc/source/user_guide_session/server-launcher.rst GitHub Actions / vale [vale] doc/source/user_guide_session/server-launcher.rst#L80 `[Google.Headings] 'API reference' should use sentence-style capitalization.` Raw output `{"message": "[Google.Headings] 'API reference' should use sentence-style capitalization.", "location": {"path": "doc/source/user_guide_session/server-launcher.rst", "range": {"start": {"line": 80, "column": 1}}}, "severity": "WARNING"}`
	~~~~~~~~~~~~~
	For more information on controlling how Mechanical launches locally, see the
	:func:`launch_mechanical() <ansys.mechanical.core.launch_mechanical>` method.
	'result8',
	'result9']

	API reference
Check warning on line 85 in doc/source/user_guide_session/pool.rst GitHub Actions / vale [vale] doc/source/user_guide_session/pool.rst#L85 `[Google.Headings] 'API reference' should use sentence-style capitalization.` Raw output `{"message": "[Google.Headings] 'API reference' should use sentence-style capitalization.", "location": {"path": "doc/source/user_guide_session/pool.rst", "range": {"start": {"line": 85, "column": 1}}}, "severity": "WARNING"}`
	-------------

	For more information, see :ref:`ref_pool_api`.
	for batch mode. You can use the first two tools from either Ansys Workbench or from
	standalone Mechanical.

	ACT in Mechanical
Check warning on line 33 in doc/source/getting_started/faq.rst GitHub Actions / vale [vale] doc/source/getting_started/faq.rst#L33 `[Google.Headings] 'ACT in Mechanical' should use sentence-style capitalization.` Raw output `{"message": "[Google.Headings] 'ACT in Mechanical' should use sentence-style capitalization.", "location": {"path": "doc/source/getting_started/faq.rst", "range": {"start": {"line": 33, "column": 1}}}, "severity": "WARNING"}`
	^^^^^^^^^^^^^^^^^

	In Mechanical, ACT is a customization framework. When specific features are missing,
	section of the Ansys Help, where you can view or download the Ansys, Inc. Licensing Guide for
	comprehensive licensing information.

	VPN issues
Check warning on line 253 in doc/source/getting_started/running_mechanical.rst GitHub Actions / vale [vale] doc/source/getting_started/running_mechanical.rst#L253 `[Google.Headings] 'VPN issues' should use sentence-style capitalization.` Raw output `{"message": "[Google.Headings] 'VPN issues' should use sentence-style capitalization.", "location": {"path": "doc/source/getting_started/running_mechanical.rst", "range": {"start": {"line": 253, "column": 1}}}, "severity": "WARNING"}`
	----------

	Sometimes, Mechanical has issues starting when VPN software is running. For more information,

	.. note::

	This is an experimental feature. Some of these libraries will not work.
Check warning on line 8 in doc/source/user_guide_embedding/libraries.rst GitHub Actions / vale [vale] doc/source/user_guide_embedding/libraries.rst#L8 `[Google.Will] Avoid using 'will'.` Raw output `{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "doc/source/user_guide_embedding/libraries.rst", "range": {"start": {"line": 8, "column": 62}}}, "severity": "WARNING"}`

	Most of Mechanical's scripting APIs are implemented in C#. However, there are a small number
	of Python modules that are distributed with the installation of Mechanical that can be used
	.. _ref_guide_wsl:

	Windows Subsystem for Linux
Check warning on line 3 in doc/source/getting_started/wsl.rst GitHub Actions / vale [vale] doc/source/getting_started/wsl.rst#L3 `[Google.Headings] 'Windows Subsystem for Linux' should use sentence-style capitalization.` Raw output `{"message": "[Google.Headings] 'Windows Subsystem for Linux' should use sentence-style capitalization.", "location": {"path": "doc/source/getting_started/wsl.rst", "range": {"start": {"line": 3, "column": 1}}}, "severity": "WARNING"}`
	===========================

	This page explains how you use a PyAnsys library, more specifically PyMechanical,
	**********************


	IP addresses
Check warning on line 254 in doc/source/getting_started/wsl.rst GitHub Actions / vale [vale] doc/source/getting_started/wsl.rst#L254 `[Google.Headings] 'IP addresses' should use sentence-style capitalization.` Raw output `{"message": "[Google.Headings] 'IP addresses' should use sentence-style capitalization.", "location": {"path": "doc/source/getting_started/wsl.rst", "range": {"start": {"line": 254, "column": 1}}}, "severity": "WARNING"}`
	------------

	The IP address ``127.0.0.1`` specified in `Run Mechanical on a local Docker image`_ is
	full path to the ``options`` file.


	IP addresses in WSL and the Windows host
Check warning on line 333 in doc/source/getting_started/wsl.rst GitHub Actions / vale [vale] doc/source/getting_started/wsl.rst#L333 `[Google.Headings] 'IP addresses in WSL and the Windows host' should use sentence-style capitalization.` Raw output `{"message": "[Google.Headings] 'IP addresses in WSL and the Windows host' should use sentence-style capitalization.", "location": {"path": "doc/source/getting_started/wsl.rst", "range": {"start": {"line": 333, "column": 1}}}, "severity": "WARNING"}`
	****************************************

	Theory: You should be able to access the Windows host using the IP address