fixup! Update docs considering changes on Rocky 24R2

CONTRIBUTING.md

@@ -1,5 +1,5 @@
-# Contributing
+# Contribute
 
-For contributing to this project, please refer to the [PyRocky Developer's Guide].
+For contributing to this project, see the [PyRocky Developer's Guide].
 
 [PyRocky Developer's Guide]: https://rocky.docs.pyansys.com/version/dev/contributing.html

README.rst

@@ -3,7 +3,7 @@ PyRocky
 
 |pyansys| |MIT| |python| |pypi| |codecov| |MIT| |black| |pre-commit|
 
-PyRocky is a Python client library to create, run and post-processing
+PyRocky is a Python client library to create, run, and postprocess
 particle dynamics simulations using `Ansys Rocky <https://www.ansys.com/products/fluids/ansys-rocky>`_,
 the most powerful DEM (discrete element method) software in the market.
 
@@ -18,13 +18,13 @@ The documentation has five sections:
 - `Getting started <https://rocky.docs.pyansys.com/version/stable/getting_started/index.html>`_: Learn
   how to install PyRocky in user mode and then launch it.
 - `User guide <https://rocky.docs.pyansys.com/version/stable/user_guide/index.html>`_: Understand how to
-  use the Rocky PrePost Scripting with PyRocky.
-- `API reference <https://rocky.docs.pyansys.com/version/stable/api/index.html>`_: Understand PyRocky API
-  endpoints, their capabilities, and how to interact with them programmatically.
+  use Rocky PrePost Scripting with PyRocky.
+- `API reference <https://rocky.docs.pyansys.com/version/stable/api/index.html>`_: Explore PyRocky
+  available methods and classes.
 - `Examples <https://rocky.docs.pyansys.com/version/stable/examples/index.html>`_: Explore end-to-end
   examples that show how to use PyRocky.
-- `Contribute <https://rocky.docs.pyansys.com/version/stable/contributing.html>`_: Learn how to contribute
-  to the PyRocky codebase or documentation.
+- `Contribute <https://rocky.docs.pyansys.com/version/stable/contributing.html>`_: Learn how to
+  contribute to the PyRocky codebase or documentation.
 
 In the upper right corner of the documentation's title bar, there is an option
 for switching from viewing the documentation for the latest stable release

doc/.vale.ini

@@ -23,6 +23,5 @@ Packages = Google
 Vocab = ANSYS
 
 [*.{md,rst}]
-
-# Apply the following styles
 BasedOnStyles = Vale, Google
+Google.Colons = NO

doc/source/index.rst

@@ -1,7 +1,7 @@
 PyRocky
 #######
 
-PyRocky is a Python client library to create, run and post-processing
+PyRocky is a Python client library to create, run, and postprocess
 particle dynamics simulations using `Ansys Rocky <https://www.ansys.com/products/fluids/ansys-rocky>`_,
 the most powerful DEM (discrete element method) software in the market.
 

doc/source/user_guide/index.rst

@@ -4,10 +4,10 @@
 User guide
 ==========
 
-Use the Rocky PrePost Scripting
--------------------------------
+Use Rocky PrePost Scripting
+---------------------------
 
-In its current shape, PyRocky is a thin layer that enables remote calls to Rocky using the
+In its current form, PyRocky is a thin layer that enables remote calls to Rocky using the
 PrePost Scripting API. This API is available through the ``RockyClient.api`` object. For
 example, the following code creates a project and saves it to disk:
 
@@ -26,13 +26,13 @@ example, the following code creates a project and saves it to disk:
 To view comprehensive PrePost Scripting documentation, in the Rocky app, select
 **Help > Manuals > PrePost Scripting**.
 
-Most methods of the PrePost Scripting, when called through PyRocky, works in the exact same way
-they work in the Rocky built-in Python Shell. However, there are differences worth noting:
+Most methods of PrePost Scripting, when called through PyRocky, work in exactly the same way
+as in the Rocky built-in Python shell. However, there are differences worth noting:
 
-- ``KAStudy.GetTimeSet``: on PyRocky this method returns a ``numpy.array`` of simulation time
+- ``RAStudy.GetTimeSet``: In PyRocky, this method returns a ``numpy.array`` of simulation time
   steps in seconds (instead of a ``TimeSet`` object).
-- ``KAElementItem.GetCurve``: this method is not supported by PyRocky. Use ``GetNumpyCurve`` to
-  get resulting curves from study entities.
+- ``KAElementItem.GetCurve``: This method is not supported by PyRocky. Use the ``GetNumpyCurve``
+  method to get resulting curves from study entities.
 
 
 Known issues

src/ansys/rocky/core/client.py

@@ -20,8 +20,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 """
-Module that defines the RockyClient class, which act as a proxy for a Rocky application
-session.
+Module that defines the ``RockyClient`` class, which acts as a proxy for a Rocky
+application session.
 """
 from collections.abc import Callable, Generator
 import pickle

src/ansys/rocky/core/launcher.py

@@ -19,7 +19,7 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
-"""Module that exposes functions to launch Rocky application."""
+"""Module that exposes functions to launch a Rocky application session."""
 import contextlib
 import os
 from pathlib import Path