chore: Fix vale errors

ansys · Dec 23, 2023 · 95040c3 · 95040c3
1 parent 8ecfa54
commit 95040c3
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 10 deletions.
diff --git a/doc/.vale.ini b/doc/.vale.ini
@@ -26,3 +26,6 @@ Vocab = ANSYS
 
 # Apply the following styles
 BasedOnStyles = Vale, Google
+
+# Inline roles are ignored
+TokenIgnores = (:.*:`.*`)
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -18,7 +18,7 @@ With it you can manage and access your data on the platform from within Python a
 What is PySimAI ?
 =================
 
-PySimAI is part of the `PyAnsys <https://docs.pyansys.com>`_ ecosystem that let's you use SimAI within a Python environment of your choice in cunjonction with other PyAnsys libraries and external Python libraries.
+PySimAI is part of the `PyAnsys <https://docs.pyansys.com>`_ ecosystem that let's you use SimAI within a Python environment of your choice in conjunction with other PyAnsys libraries and external Python libraries.
 
 Install
 =======
@@ -91,7 +91,7 @@ Run or get a post-processing through the :attr:`~ansys.simai.core.data.predictio
 
 You can learn more about the available post-processings :ref:`here<post_processings>`.
 
-You're all set! You can now look into more advanced concepts like :ref:`configuring your SDK<configuration>`,
+You're all set: you can now look into more advanced concepts like :ref:`configuring your SDK<configuration>`,
 :ref:`data exploration<data_exploration>` or :ref:`best practices<best_practices>`.
 If you want to explore the functions and methods available to you in the SDK,
 you can head over to the :ref:`API reference<api_reference>` section.
diff --git a/doc/source/user_guide.rst b/doc/source/user_guide.rst
@@ -1,4 +1,4 @@
-User Guide
+User guide
 ==========
 
 .. toctree::

diff --git a/doc/source/user_guide/best_practices.rst b/doc/source/user_guide/best_practices.rst
@@ -13,7 +13,7 @@ This behavior makes it possible to request multiple computations to be ran on th
 SimAI platform without waiting for any of the data to be available.
 
 To wait for an object to be fully available, you can call the ``wait()`` method on the object
-(e.g. :meth:`Prediction.wait()<ansys.simai.core.data.predictions.Prediction.wait>`) or you can call the global
+(for example :meth:`Prediction.wait()<ansys.simai.core.data.predictions.Prediction.wait>`) or you can call the global
 :meth:`SimAIClient.wait()<ansys.simai.core.client.SimAIClient.wait>` method to wait for all requests to be complete.
 Alternatively you can try to access the object's data in which case the SDK will automatically wait for the data to be ready if needed.
 

diff --git a/doc/source/user_guide/proxy.rst b/doc/source/user_guide/proxy.rst
@@ -31,7 +31,7 @@ but the proxy is not trusted by your computer (your web browser uses a
 
 To fix this:
 
-1. Extract the certificate(s) used by your company-configured browser on ``https://simai.ansys.com``
+1. Extract the certificates used by your company-configured browser on ``https://simai.ansys.com``
 2. Set the ``REQUESTS_CA_BUNDLE`` environment variable:
 
   .. code:: python

diff --git a/doc/styles/Vocab/ANSYS/accept.txt b/doc/styles/Vocab/ANSYS/accept.txt
@@ -1,3 +1,7 @@
-ANSYS
-Ansys
-ansys
+(?i)ansys
+[Aa]synchronicity
+csv
+https_proxy
+[Nn]amespace
+(?i)simai
+zipfile
diff --git a/doc/styles/Vocab/SimAI/accept.txt b/doc/styles/Vocab/SimAI/accept.txt
diff --git a/doc/styles/Vocab/SimAI/reject.txt b/doc/styles/Vocab/SimAI/reject.txt