Skip to content

Commit 58a1184

Browse files
authored
doc: general updtes for adherence to standards (#271)
2 parents 5363d66 + e691717 commit 58a1184

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

doc/source/getting_started/building_stk_images.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ End of the tab
109109
110110
docker compose build
111111
112-
#. Build a single images by running:
112+
#. Build a single image by running:
113113

114114
.. code-block::
115115
@@ -182,7 +182,7 @@ The docker run command is utilized to create and run a container from a Docker
182182
image. Various options are available to customize the container creation
183183
process.
184184

185-
- ``--detach`` Runs the container in detached mode, allowing it to run in the background.
185+
- ``--detach`` Runs the container in detached mode, enabling it to run in the background.
186186
- ``--interactive`` Enables interactive mode, providing a TTY session for connecting to the container.
187187
- ``--tty`` Allocates a pseudo-TTY, ensuring proper formatting and display of the container's output.
188188
- ``--network="host"`` Shares the host's network stack with the container, enabling network connectivity.
@@ -236,7 +236,7 @@ Command breakdown
236236
The ``docker exec`` command is used to execute commands within a Docker
237237
container. It provides several options to enhance the execution experience.
238238

239-
- ``--interactive`` Allows interactive mode, enabling interaction with the command executed within the container.
239+
- ``--interactive`` Enables interactive mode, enabling interaction with the command executed within the container.
240240
- ``--tty`` Allocates a pseudo-TTY, ensuring proper formatting and display of the executed command's output.
241241
- ``<container-name>`` Specifies the name or ID of the target container in which the command should be executed.
242242
- ``<command>`` Represents the shell command that you want to execute within the container.

doc/source/getting_started/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ To run PySTK, you must have a licensed copy of `STK`_.
1010
:link: building_stk_images
1111
:link-type: doc
1212

13-
Step by step guidelines on how to build your own Docker image for STK.
13+
Step-by-step guidelines on how to build your own Docker image for STK.
1414

1515
.. grid-item-card:: Installing PySTK :fab:`python`
1616
:link: installing_pystk

doc/source/getting_started/installing_pystk.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ PySTK is just a Python API to STK, meaning that STK is still required to perform
88
all the necessary computations.
99

1010
Make sure that you followed the ``building_stk_images`` guide to properly
11-
containerize STK. PySTK can also attach to an STK instance in your machine,
12-
being able to launch the product.
11+
containerize STK. PySTK can also attach to an STK instance on your machine,
12+
with the ability to launch the product.
1313

1414

1515
User installation
@@ -50,7 +50,7 @@ These include ``pip`` and ``GitHub``.
5050
Developer installation
5151
======================
5252

53-
The developer installation is specifically intended for project maintainers.
53+
Developer installation is specifically intended for project maintainers.
5454
This specialized installation is tailored to equip developers with the essential
5555
tools and resources required for effective contribution to the project's
5656
development and maintenance. The developer installation assumes a certain level
@@ -118,8 +118,8 @@ Activate previous environment:
118118
source <venv>/bin/activate
119119
120120
Install the project in editable mode. This means that any changes you make to
121-
the package's source code immediately reflect in your project without requiring
122-
to reinstalling it.
121+
the package's source code immediately reflect in your project without requiring you
122+
to reinstall it.
123123

124124
.. code-block::
125125

doc/source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ PySTK provides a Python API to interact with `Ansys Systems Tool Kit`_ (STK).
3737
:link-type: doc
3838

3939
A detailed guide describing the PySTK API. This guide documents all the
40-
methods and properties for each one of the interfaces, classes and
41-
enumerations of each one of the modules in PySTK.
40+
methods and properties for each interface, class, and
41+
enumerations of each PySTK module.
4242
{% endif %}
4343

4444
{% if build_examples %}

0 commit comments

Comments
 (0)