Doc/wording

codegen/tuigen.py

@@ -310,7 +310,7 @@ def generate(self) -> None:
                 self._populate_menu(self._main_menu, info)
             self.session.exit()
             self._write_code_to_tui_file(
-                f'"""Fluent {self._mode.title()} TUI Commands"""\n'
+                f'"""Fluent {self._mode.title().lower()} TUI commands"""\n'
             )
             self._main_menu.doc = f"Fluent {self._mode} main menu."
             self._write_code_to_tui_file(

doc/source/api/general/index.rst

@@ -6,73 +6,72 @@ General
 Launcher
 ########
 
-:ref:`ref_launcher` provides access to starting Fluent locally in server mode or connecting to a running Fluent
-server instance.
-
-Asynchronous execution
-######################
-
-:ref:`ref_utils` consists solely of a function to allow for asynchronous execution.
+:ref:`ref_launcher` includes instructions on how to launch and connect to Fluent.
 
 Sessions
 ########
 
-:ref:`ref_sessions` consists of available Fluent sessions.
+:ref:`ref_sessions` describes the various types of PyFluent session objects, which connect to Fluent sessions.
 
 Services
 ########
 
-:ref:`ref_services` consists of gRPC services for Fluent sessions.
+:ref:`ref_services` outlines fundamental gRPC services, upon which PyFluent depends (and are directly usable).
 
 Streaming services
 ##################
 
-:ref:`ref_streaming_services` consists of streaming services for management of gRPC services.
-
-Post objects
-############
-
-:ref:`ref_post_objects` consists of visualization objects for Matplotlib.
+:ref:`ref_streaming_services` outlines fundamental gRPC streaming services, upon which PyFluent depends (and are directly usable).
 
 Scheduler
 #########
 
-:ref:`ref_scheduler` consists of abstract machine objects and their use for queue system interface.
+:ref:`ref_scheduler` describes a module for facilitating use of external job scheduling systems.
 
-Case reader
-###########
+Case
+####
 
-:ref:`ref_case_reader` demonstrates reading of Fluent's case files.
+:ref:`ref_case_reader` documents a class for parsing Fluent case files in pure Python code.
 
 Data transfer
 #############
 
-:ref:`ref_data_transfer` demonstrates transfer of Fluent's case files.
+:ref:`ref_data_transfer` describes how to transfer mesh data between PyFluent sessions.
 
 Journaling
 ##########
 
-:ref:`ref_journaling` consists of read-write of journal.
-
-Meta
-####
+:ref:`ref_journaling` explains how to read and write Python journals that are reusable between PyFluent and Fluent.
 
-:ref:`ref_meta` consists of used meta classes.
-
-Quantity
+Workflow
 ########
 
-:ref:`ref_quantity` is a module for creation and manipulation of physical quantities.
+:ref:`ref_workflow` documents high-level interfaces to the task-based workflows, including meshing workflow.
 
 rpvars
 ######
 
-:ref:`ref_rpvars` shows access and modification of rpvars.
+:ref:`ref_rpvars` shows how you can access and modify live Fluent rpvars via PyFluent.
 
-Workflow
+Quantity
 ########
 
-:ref:`ref_workflow` used for creation of TaskObject instance.
+:ref:`ref_quantity` reveals a powerful quantity class that exposes real values and units of API (and other) objects.
+
+Post objects
+############
+
+:ref:`ref_post_objects` documents visualization objects for interfacing to Matplotlib and pyvista.
+
+Asynchronous execution
+######################
+
+:ref:`ref_utils` documents tools for asynchronous function execution.
+
+Meta
+####
+
+:ref:`ref_meta` consists of some metaclasses used in the PyFluent codebase.
 
 .. currentmodule:: ansys.fluent.core
 

doc/source/api/index.rst

@@ -8,25 +8,27 @@ solver components of Fluent.
 General
 #######
 
-The :ref:`ref_general` component describes starting of Fluent and it's asynchronous execution, types of various
-Fluent sessions, use of gRPC and streaming services, creation of visualization objects for Matplotlib and abstract
-machine object for queue system interface, contains examples to read and transfer Fluent's case files in addition
-to this it contains information about used meta classes, rpvars, workflow objects, recording journals and module for
-creation of  physical quantities using real values and units.
+Features of PyFluent not specifically belonging to either the Meshing or Solver modes are collected together in the
+:ref:`ref_general` section. That includes instructions on how to launch and connect to Fluent, and the various types of
+PyFluent session objects, which connect to Fluent sessions, are documented. Fundamental gRPC services, including
+streaming services, upon which PyFluent depends (and are directly usable) are outlined. Other features include a
+Scheduler module for facilitating use of external job scheduling systems, a purely Python-based reader for Fluent
+project and case files, Python-based journaling, task-based workflow objects, full Pythonic access to Fluent rp-vars,
+powerful quantity objects that expose real values and units of API (and other) objects, visualization objects for
+interfacing to Matplotlib and pyvista, and tools for asynchronous and batched command execution.
 
 Meshing
 #######
 
-The :ref:`ref_meshing` mode is dedicated to capturing the capabilities of the Fluent Meshing guided workflows and
-associated tools. This component consists of an interface that is derived from the Fluent (meshing) TUI, as well as
-a meshing workflow interface that manages workflow tasks, meshing functions, and part management.
+The :ref:`ref_meshing` mode provides Pythonic interfaces to the Fluent meshing TUI, Fluent meshing guided workflows,
+and part management.
 
 Solver
 ######
 
 The :ref:`ref_solver` mode is dedicated to capturing the power of the Fluent solver. This component consists of a
-:ref:`ref_settings`-based interface or a :ref:`ref_solver_tui`-based interface that is derived from the Fluent
-(solver) TUI, as well as access to Fluent surface, scalar and vector field data.
+:ref:`ref_settings`-based interface and a :ref:`ref_solver_tui`-based interface that is derived from the Fluent
+Solver TUI, as well as access to surface data and scalar and vector field data.
 
 
 .. toctree::

doc/styles/Vocab/ANSYS/accept.txt

@@ -17,6 +17,8 @@ Matplotlib
 matplotlib
 mesher
 meshing's
+metaclass
+metaclasses
 MonitorsManager
 numpy
 pathlines

src/ansys/fluent/core/__init__.py

@@ -9,7 +9,7 @@
 from ansys.fluent.core._version import __version__  # noqa: F401
 from ansys.fluent.core.launcher.launcher import (  # noqa: F401
     FluentVersion,
-    LaunchModes,
+    LaunchMode,
     launch_fluent,
 )
 from ansys.fluent.core.services.batch_ops import BatchOps  # noqa: F401

src/ansys/fluent/core/journaling.py

@@ -1,16 +1,16 @@
-"""A module for maintaining journals."""
+"""A module for controlling the writing of Fluent Python journals."""
 
 
 class Journal:
-    """Manages journal streaming."""
+    """Control the writig of Fluent Python journals."""
 
     def __init__(self, scheme_eval):
         self.scheme_eval = scheme_eval
 
     def start(self, file_path: str):
-        """Starts writing a journal to the file_path."""
+        """Start writing a Fluent Python journal at the specified file_path."""
         self.scheme_eval.exec([f'(api-start-python-journal "{file_path}")'])
 
     def stop(self):
-        """Stops writing the journal."""
+        """Stop writing the Fluent Python journal."""
         self.scheme_eval.exec([f"(api-stop-python-journal)"])