Skip to content

Commit

Permalink
docs: Add workflow wrapper to workflow API (#2573)
Browse files Browse the repository at this point in the history
* fix: Add exception to handle unconfigured upload/download methods

* docformatter fix

* docs: Add workflow wrapper to workflow API

* tui use

* tui use 1

* vale fix

* vale fix 2

* vale fix 3

* vale fix 4

* vale fix 5

* resolve conflict

* resolve conflict 1

* vale fix 6

* resolve conflict 2

* workflow wrapper
  • Loading branch information
hpohekar authored Mar 14, 2024
1 parent e88e096 commit 8e34bda
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/source/user_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,8 @@ A meshing mode session has an active ``meshing`` object that provides two
distinct interfaces to the mesher:

- ``tui`` object
- meshing workflow, which consists of ``meshing`` and ``workflow`` properties and the
``PartManagement`` and ``PMFileMangement`` classes
- meshing workflow, which consists of :ref:`meshing <ref_meshing_datamodel_meshing>` and :ref:`workflow <ref_meshing_datamodel_workflow>` properties and the
:ref:`PartManagement <ref_meshing_datamodel_PartManagement>` and :ref:`PMFileMangement <ref_meshing_datamodel_PMFileManagement>` classes

Meshing ``tui`` object
~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -131,7 +131,7 @@ For the full hierarchy under the meshing ``tui`` object, see

``Meshing`` and ``Workflow`` properties
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The ``meshing`` object has ``meshing`` and ``workflow`` properties that together
The ``meshing`` object has :ref:`meshing <ref_meshing_datamodel_meshing>` and :ref:`workflow <ref_meshing_datamodel_workflow>` properties that together
provide access to Fluent's meshing workflows. This interface is consistent with
the Python meshing workflow interface that Fluent meshing exposes directly:

Expand Down

0 comments on commit 8e34bda

Please sign in to comment.