docs: Update ui_mode doc [skip tests] (#4533)

closes #3886

**Context**

Prior to this change, the ui_mode parameter in several parts of the
PyFluent codebase had an incomplete or slightly misleading docstring.
Users could pass either members of the UIMode enum or specific string
literals (e.g. "no_gui", "hidden_gui", etc.), but that flexibility was
not well documented. This ambiguity could lead to confusion about which
string names are valid and how they map to enum values.

**Change Summary**

Updated the docstrings in launcher.py, slurm_launcher.py, and
session_utilities.py to better describe accepted ui_mode values (both
enum and string forms).

Clarified which string names correspond to which UIMode values (e.g.
"no_gui_or_graphics", "no_gui", "hidden_gui", "gui", etc.).

Removed or refined outdated or redundant lines in the existing doc
comments.

Ensured consistency across the codebase about how ui_mode is explained.

Marked the PR to skip tests, since only docstrings were changed.

**Rationale**

Better user experience / usability: Clear documentation helps users (and
maintainers) know exactly what ui_mode values are supported.

Reduce confusion / errors: Users may try unsupported strings or misuse
the enum; this aims to guide them.

Maintain consistency: Before, docstrings in different modules had slight
variations or omissions. This change harmonizes those descriptions.

Low risk: Since only documentation is modified (no logic changes), this
is a safe improvement.

**Impact**

Documentation / developer experience: Anyone reading or using code
involving ui_mode will get more precise information on acceptable
values.

Minimal to no runtime impact: Because no functional logic was changed,
existing behavior remains unchanged.

Future maintenance: When extending or deprecating a ui_mode, future
contributors can rely on the docstrings being consistent across modules.

Testing: No tests should break (and the PR is marked [skip tests]), but
doc validation tools (if present) may pick up formatting or lint
changes.

---------

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

Author: hpohekar

doc/changelog.d/4533.documentation.md

@@ -0,0 +1 @@
+Update ui_mode doc [skip tests]

src/ansys/fluent/core/launcher/container_launcher.py

@@ -118,8 +118,9 @@ def __init__(
         ----------
         mode : FluentMode
             Specifies the launch mode of Fluent to target a specific session type.
-        ui_mode : UIMode
-            Defines the user interface mode for Fluent. Options correspond to values in the ``UIMode`` enum.
+        ui_mode : UIMode or str, optional
+            Defines the user interface mode for Fluent. Accepts either a ``UIMode`` value
+            or a corresponding string such as ``"no_gui"``, ``"hidden_gui"``, or ``"gui"``.
         graphics_driver : FluentWindowsGraphicsDriver or FluentLinuxGraphicsDriver
             Specifies the graphics driver for Fluent. Options are from the ``FluentWindowsGraphicsDriver`` enum
             (for Windows) or the ``FluentLinuxGraphicsDriver`` enum (for Linux).

src/ansys/fluent/core/launcher/launcher.py

@@ -240,12 +240,8 @@ def launch_fluent(
         Fluent transcript subsequently via the method calls, ``transcript.start()``
         and ``transcript.stop()`` on the session object.
     ui_mode : UIMode or str, optional
-        Fluent user interface mode. Options are either the values of the ``UIMode``
-        enum or any of ``"no_gui_or_graphics"``, ``"no_gui"``, ``"hidden_gui"``,
-        ``"no_graphics"`` or ``"gui"``. The default is ``UIMode.HIDDEN_GUI`` in
-        Windows and ``UIMode.NO_GUI`` in Linux. ``"no_gui_or_graphics"`` and
-        ``"no_gui"`` user interface modes are supported in Windows starting from Fluent
-        version 2024 R1.
+        Defines the user interface mode for Fluent. Accepts either a ``UIMode`` value
+        or a corresponding string such as ``"no_gui"``, ``"hidden_gui"``, or ``"gui"``.
     graphics_driver : FluentWindowsGraphicsDriver or FluentLinuxGraphicsDriver or str, optional
         Graphics driver of Fluent. In Windows, options are either the values of the
         ``FluentWindowsGraphicsDriver`` enum or any of ``"null"``, ``"msw"``,

src/ansys/fluent/core/launcher/pim_launcher.py

@@ -96,8 +96,9 @@ def __init__(
         ----------
         mode : FluentMode
             Specifies the launch mode of Fluent for targeting a specific session type.
-        ui_mode : UIMode
-            Defines the user interface mode for Fluent. Options correspond to values in the ``UIMode`` enum.
+        ui_mode : UIMode or str, optional
+            Defines the user interface mode for Fluent. Accepts either a ``UIMode`` value
+            or a corresponding string such as ``"no_gui"``, ``"hidden_gui"``, or ``"gui"``.
         graphics_driver : FluentWindowsGraphicsDriver or FluentLinuxGraphicsDriver
             Specifies the graphics driver for Fluent. Options are from the ``FluentWindowsGraphicsDriver`` enum
             (for Windows) or the ``FluentLinuxGraphicsDriver`` enum (for Linux).

src/ansys/fluent/core/launcher/slurm_launcher.py

@@ -316,8 +316,9 @@ def __init__(
         ----------
         mode : FluentMode
             Launch mode of Fluent to point to a specific session type.
-        ui_mode : UIMode
-            Fluent user interface mode. Options are the values of the ``UIMode`` enum.
+        ui_mode : UIMode or str, optional
+            Defines the user interface mode for Fluent. Accepts either a ``UIMode`` value
+            or a corresponding string such as ``"no_gui"``, ``"hidden_gui"``, or ``"gui"``.
         graphics_driver : FluentWindowsGraphicsDriver or FluentLinuxGraphicsDriver
             Graphics driver of Fluent. Options are the values of the
             ``FluentWindowsGraphicsDriver`` enum in Windows or the values of the

src/ansys/fluent/core/launcher/standalone_launcher.py

@@ -113,8 +113,9 @@ def __init__(
         ----------
         mode : FluentMode
             Specifies the launch mode of Fluent to target a specific session type.
-        ui_mode : UIMode
-            Defines the user interface mode for Fluent. Options correspond to values in the ``UIMode`` enum.
+        ui_mode : UIMode or str, optional
+            Defines the user interface mode for Fluent. Accepts either a ``UIMode`` value
+            or a corresponding string such as ``"no_gui"``, ``"hidden_gui"``, or ``"gui"``.
         graphics_driver : FluentWindowsGraphicsDriver or FluentLinuxGraphicsDriver
             Specifies the graphics driver for Fluent. Options are from the ``FluentWindowsGraphicsDriver`` enum
             (for Windows) or the ``FluentLinuxGraphicsDriver`` enum (for Linux).

src/ansys/fluent/core/session_utilities.py

@@ -90,8 +90,9 @@ def from_install(
 
         Parameters
         ----------
-        ui_mode : UIMode
-            Defines the user interface mode for Fluent. Options correspond to values in the ``UIMode`` enum.
+        ui_mode : UIMode or str, optional
+            Defines the user interface mode for Fluent. Accepts either a ``UIMode`` value
+            or a corresponding string such as ``"no_gui"``, ``"hidden_gui"``, or ``"gui"``.
         graphics_driver : FluentWindowsGraphicsDriver or FluentLinuxGraphicsDriver
             Specifies the graphics driver for Fluent. Options are from the ``FluentWindowsGraphicsDriver`` enum
             (for Windows) or the ``FluentLinuxGraphicsDriver`` enum (for Linux).
@@ -194,8 +195,9 @@ def from_container(
 
         Parameters
         ----------
-        ui_mode : UIMode
-            Defines the user interface mode for Fluent. Options correspond to values in the ``UIMode`` enum.
+        ui_mode : UIMode or str, optional
+            Defines the user interface mode for Fluent. Accepts either a ``UIMode`` value
+            or a corresponding string such as ``"no_gui"``, ``"hidden_gui"``, or ``"gui"``.
         graphics_driver : FluentWindowsGraphicsDriver or FluentLinuxGraphicsDriver
             Specifies the graphics driver for Fluent. Options are from the ``FluentWindowsGraphicsDriver`` enum
             (for Windows) or the ``FluentLinuxGraphicsDriver`` enum (for Linux).
@@ -287,7 +289,8 @@ def from_pim(
         Parameters
         ----------
         ui_mode : UIMode or str, optional
-            Defines the user interface mode for Fluent. Options correspond to values in the ``UIMode`` enum.
+            Defines the user interface mode for Fluent. Accepts either a ``UIMode`` value
+            or a corresponding string such as ``"no_gui"``, ``"hidden_gui"``, or ``"gui"``.
         graphics_driver : FluentWindowsGraphicsDriver or FluentLinuxGraphicsDriver
             Specifies the graphics driver for Fluent. Options are from the ``FluentWindowsGraphicsDriver`` enum
             (for Windows) or the ``FluentLinuxGraphicsDriver`` enum (for Linux).