diff --git a/doc/source/user_guide/mapdl.rst b/doc/source/user_guide/mapdl.rst index e7dea24564..4d9ed18c3d 100644 --- a/doc/source/user_guide/mapdl.rst +++ b/doc/source/user_guide/mapdl.rst @@ -161,7 +161,7 @@ the MAPDL instance, and runs it using the :meth:`Mapdl.input() ` method. -For instance, the following :meth:`non_interactive context `: +For instance, this example code uses the :meth:`non_interactive context ` method to generate input for MAPDL: .. code:: python @@ -169,19 +169,19 @@ For instance, the following :meth:`non_interactive context ` call. +This MAPLD input is executed with a :meth:`Mapdl.input() ` method call. Because of the non-interactive context not running all the commands until the end, you might find issues interacting inside it, with Python for instance. -For example, running Python commands such as -:func:`Mapdl.get_array() ` +For example, running Python commands such as the +:meth:`Mapdl.get_array() ` method inside the context can give you out-of-sync responses. The following code snippet is a demonstration of this kind of problem: @@ -201,8 +201,8 @@ The following code snippet is a demonstration of this kind of problem: assert klist_inside != klist_outside # Evaluates to true -In the preceding script, the values obtained by -:func:`Mapdl.get_array() ` are different: +In the preceding script, the values obtained by the +:meth:`Mapdl.get_array() ` method are different: .. code:: pycon @@ -211,21 +211,20 @@ In the preceding script, the values obtained by >>> print(klist_outside) array([1., 2., 3.]) -This is because the first :func:`Mapdl.get_array() ` -call is executed actually *before* the :func:`Mapdl.k() ` call. +This is because the first :meth:`Mapdl.get_array() ` +method call is executed *before* the :meth:`Mapdl.k() ` method call. -It is recommend to not retrieve any data in a pythonic way from the MAPDL instance while in the -:meth:`non_interactive context `. -Being aware of this kind of behavior and how -:meth:`non_interactive context ` -works is crucial for an advanced usage of PyMAPDL. +You should not retrieve any data in a Pythonic way from the MAPDL instance while using the +:meth:`non_interactive context ` method. +Being aware of this kind of behavior and how the :meth:`non_interactive context ` method +works is crucial for advanced usage of PyMAPDL. MAPDL macros ------------ Note that macros created within PyMAPDL (rather than loaded from -a file) do not appear to run correctly. For example, here is the macro -``DISP`` created using the ``*CREATE`` command within APDL and within PyMAPDL: +a file) do not appear to run correctly. For example, here is the ``DISP`` +macro created using the ``*CREATE`` command within APDL and within PyMAPDL: .. tab-set:: @@ -522,7 +521,7 @@ Prompts ------- Prompts from MAPDL automatically continued as if MAPDL is in batch mode. Commands requiring user input, such as the -:func:`Mapdl.vwrite() ` method fail +:meth:`Mapdl.vwrite() ` method, fail and must be entered in non-interactively. diff --git a/src/ansys/mapdl/core/parameters.py b/src/ansys/mapdl/core/parameters.py index e9960b352b..0d8053e94d 100644 --- a/src/ansys/mapdl/core/parameters.py +++ b/src/ansys/mapdl/core/parameters.py @@ -334,7 +334,7 @@ def __getitem__(self, key): raise MapdlRuntimeError( "Cannot use `mapdl.parameters` to retrieve parameters when in " "`non_interactive` mode. " - "Exit non_interactive mode before using this method." + "Exit `non_interactive` mode before using this method." ) if not isinstance(key, str):