fix some doc mistakes (#91)

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>

Author: 3 people

doc/changelog.d/91.miscellaneous.md

@@ -0,0 +1 @@
+fix some doc mistakes

doc/source/getting-started/connection.rst

@@ -7,13 +7,27 @@ Workbench. Different options exist, including local and remote connections.
 Local connection
 ================
 
-You can connect PyWorkbench to a local connection of Ansys Workbench by running
+You can connect PyWorkbench to a local session of Ansys Workbench by running
 the following steps:
 
 1. Start Ansys Workbench
 2. In the Workbench Command Window, type ``StartServer()``
 3. Take a note of the returned port number
-4. Use previous port number to connect PyWorkbench to the server
+4. Use the port number to connect PyWorkbench to the server:
+
+.. code-block:: python
+
+    from ansys.workbench.core import connect_workbench
+
+    workbench = connect_workbench(port=port)
 
 Remote connection
 =================
+You can connect PyWorkbench to an Ansys Workbench session running on a remote
+computer by giving its computer name or IP and the port number that the service uses:
+
+.. code-block:: python
+
+    from ansys.workbench.core import connect_workbench
+
+    workbench = connect_workbench(host=host_name_or_IP, port=port)

doc/source/user-guide.rst

@@ -10,36 +10,35 @@ Start Workbench client and connect to a running Workbench server
 To start a Workbench client that connects to a running Workbench server on the cloud, you
 must provide the following information:
 
-- Server name or IP address
 - Port number
-- Client-side working directory, which is the default location for client-side files
+- Server name or IP address, which is an optional parameter and when not specified, localhost is used
+- Client-side working directory, which is an optional parameter indicating the default location for client-side files
 
 .. code-block:: python
 
-    from ansys.workbench.core.workbench_client import connect_workbench
+    from ansys.workbench.core import connect_workbench
 
     host = "server_machine_name_or_IP"
     port = server_port_number
     wb = connect_workbench(host=host, port=port)
 
-Other options to the ``connect_workbench()`` function include specifying a working directory for
-the client instead of using the default directory.
+The ``client_workdir`` parameter for the ``connect_workbench()`` function specifies a working
+directory for the client instead of using the default directory.
 
 Launch Workbench server and start a client
 ==========================================
 
 During the development phase or when debugging, it is useful to start the
 Workbench server on your desktop or some computer within the company network.
 
-You can always start a Workbench server by running the ``StartServer()`` function
-in any running Workbench session. You then use the returned server port to start a client,
+You can always start a Workbench server by running the ``StartServer()`` command
+in any Workbench session. You then use the returned server port to start a client,
 like in the preceding example.
 
 Alternatively, you can launch a Workbench server and start a client programmatically in a
 client-side Python script.
 
-This code launches a server on a local Windows machine with
-valid user credentials:
+This code launches a server on a local Windows machine:
 
 .. code-block:: python
 
@@ -76,13 +75,13 @@ Run scripts on Workbench server
 ===============================
 
 You can use these methods to run IronPython-based Workbench scripts, which contain commands or
-queries, on the Workbench server:
+queries, with PyWorkbench:
 
 - ``run_script_file``: Runs a script file in the client working directory.
 - ``run_script_string``: Runs a script contained in the given string.
 
-In the ```wb_script_result`` global variable in the script, you can assign any output that needs
-to be returned from these methods as a JSON string. For example, this Workbench script returns
+To the ``wb_script_result`` global variable in the script, you can assign any output that needs
+to be returned from these methods, as a JSON string. For example, this Workbench script returns
 all message summaries from the Workbench session:
 
 .. code-block:: python
@@ -92,9 +91,9 @@ all message summaries from the Workbench session:
     messages = [m.Summary for m in GetMessages()]
     wb_script_result = json.dumps(messages)
 
-You can also call these these methods with different logging levels. While the default logging
-level is ``error``, this line outputs all ``info``, ``warning``, and ``error`` levels
-to the logger when the script run:
+You can also call these methods with different logging levels. While the default logging
+level is ``error``, the following example outputs all ``info``, ``warning``, and ``error`` levels
+to the logger when the script runs:
 
 .. code-block:: python
 
@@ -106,10 +105,10 @@ Upload and download files
 You can upload and download data files to and from the server using the ``upload_file()`` and ``download_file``
 methods. The client-side working directory is used to hold these files unless absolute paths or target directories
 are specified. There is also a working directory on the server for the same purpose. To obtain the server’s working
-directory, you can use the the ``GetServerWorkingDirectory()`` Workbench query that runs on the server.
+directory, you can use the ``GetServerWorkingDirectory()`` query in the scripts that run on the server.
 
-This code uploads all part files with a given prefix, all AGDB files in the working directory, and another file
-outside of the working directory from the client to the server:
+This code uploads all part files of a given prefix and all AGDB files in the working directory, along with another file
+outside of the working directory, from the client to the server:
 
 .. code-block:: python
 
@@ -123,15 +122,14 @@ newly created Workbench system:
     wb.run_script_string(
         r"""import os
     work_dir = GetServerWorkingDirectory()
-    geometry_file = os.path.join(work_dir, "2pipes.agdb")
+    geometry_file = os.path.join(work_dir, "two_pipes.agdb")
     template = GetTemplate(TemplateName="Static Structural", Solver="ANSYS")
     system = CreateSystemFromTemplate(Template=template, Name="Static Structural (ANSYS)")
     system.GetContainer(ComponentName="Geometry").SetFile(FilePath=geometry_file)
     """
     )
 
-This server-side Workbench script copies a Mechanical solver output file to the server's working directory
-for downloading later:
+This server-side Workbench script copies a Mechanical solver output file to the server's working directory:
 
 .. code-block:: python
 
@@ -146,13 +144,13 @@ for downloading later:
     """
     )
 
-This client script downloads all files with OUT extensions from the server's working directory:
+This client script downloads all files with ``.out`` extensions from the server's working directory:
 
 .. code-block:: python
 
     wb.download_file("*.out")
 
-There is a special client method to upload a data file from the
+There is a special client method to upload a data file from the Ansys
 `example-data <https://github.com/ansys/example-data/tree/master/pyworkbench>`_ repository
 directly to the Workbench server. You should specify the file path relative to the
 ``pyworkbench`` folder in the ``example-data`` repository:
@@ -168,7 +166,7 @@ turn off the progress bar with an optional argument:
 
     wb.download_file("solve.out", show_progress=False)
 
-Start other PyAnsys services from systems in a PyWorkbench project
+Start other PyAnsys services for systems in a Workbench project
 ==================================================================
 
 PyMechanical

src/ansys/workbench/core/__init__.py

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-"""PyWorkbench client in Python: ansys-workbench-core."""
+"""PyWorkbench Python client."""
 
 import importlib.metadata as importlib_metadata
 

src/ansys/workbench/core/public_api.py

@@ -20,7 +20,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-"""Module for launching a Workbench server on a local or remote Windows machine."""
+"""Module for starting PyWorkbench."""
 
 import logging
 import os
@@ -263,7 +263,7 @@ def launch_workbench(
 
     Parameters
     ----------
-    release : str, default: "242"
+    release : str, default: "251"
         Workbench release to launch.
     client_workdir : str, default: None
         Path to a writable directory on the client computer. The default is ``None``,
@@ -283,7 +283,7 @@ def launch_workbench(
 
     Returns
     -------
-    ClientWrapper
+    WorkbenchClient
         Instance of the PyWorkbench client that is connected to the launched server.
 
     Examples
@@ -312,7 +312,7 @@ def connect_workbench(port, client_workdir=None, host=None):
 
     Returns
     -------
-    ClientWrapper
+    WorkbenchClient
         Instance of the PyWorkbench client that is connected to the server.
 
     Examples

src/ansys/workbench/core/workbench_client.py

@@ -38,7 +38,7 @@
 
 
 class WorkbenchClient:
-    """Provides the PyWorkbench client.
+    """Functions of a PyWorkbench client.
 
     Parameters
     ----------
@@ -109,7 +109,7 @@ def set_console_log_level(self, log_level):
     def set_log_file(self, log_file):
         """Set a local log file for the Workbench server log.
 
-        Create a locl log file if one does not exist and append it to the existing log file.
+        Create a local log file if one does not exist and append it to the existing log file.
 
         Parameters
         ----------
@@ -136,7 +136,7 @@ def reset_log_file(self):
     __log_console_handler = None
 
     def run_script_string(self, script_string, log_level="error"):
-        """Run a script on the server.
+        """Run a script as given in the input string on the server.
 
         Parameters
         ----------
@@ -183,7 +183,7 @@ def run_script_file(self, script_file_name, log_level="error"):
         Parameters
         ----------
         script_file_name : str
-            Name of the script file to run. The script file is located in the client
+            Name of the script file to run. The script file should be located in the client
             working directory
         log_level : str, default: "error"
             Level of logging. Options are "critical" "debug", "error", "info", and "warning".
@@ -214,7 +214,7 @@ def upload_file(self, *file_list, show_progress=True):
         Returns
         -------
         list[str]
-            Names of the uploaded file.
+            Names of the uploaded files.
         """
         if not self._is_connected():
             logging.error("Workbench client is not yet connected to a server.")
@@ -311,7 +311,7 @@ def download_file(self, file_name, show_progress=True, target_dir=None):
         Returns
         -------
         str
-            Names of the one or more downloaded files.
+            Name of the downloaded file.
         """
         if not self._is_connected():
             logging.error("Workbench client is not yet connected to a server.")
@@ -439,7 +439,7 @@ def start_mechanical_server(self, system_name):
         Returns
         -------
         int
-            Port number of the PyMechanical server used to start the PyMechanical client.
+            Port of the PyMechanical server to use to start the PyMechanical client.
 
         Examples
         --------
@@ -504,7 +504,7 @@ def start_sherlock_server(self, system_name):
         Returns
         -------
         int
-            Prt number of the PySherlock server used to start a PySherlock client.
+            Port of the PySherlock server to use to start a PySherlock client.
 
         Examples
         --------