Update src/ansys/mapdl/core/launcher.py

Co-authored-by: Camille <78221213+clatapie@users.noreply.github.com>
ansys · Mar 20, 2024 · 8f9efa9 · 8f9efa9
1 parent f50a0c6
commit 8f9efa9
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/ansys/mapdl/core/launcher.py b/src/ansys/mapdl/core/launcher.py
@@ -799,6 +799,11 @@ def get_start_instance(start_instance: bool = True):
         Raised when ``PYMAPDL_START_INSTANCE`` is not either true or false
         (case independent).
 
+    Notes
+    -----
+    If the environment variable ``PYMAPDL_START_INSTANCE`` is set,
+    hence the argument ``start_instance`` is overwritten.
+      
     """
     if "PYMAPDL_START_INSTANCE" in os.environ and os.environ["PYMAPDL_START_INSTANCE"]:
         # It should not be empty