DOCS: Update parameter names from 'specified_version' to 'version' in multiple files (#7279)

Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>

Author: Samuelopez-ansys

README.md

@@ -238,9 +238,9 @@ Usage examples follow.
 from ansys.aedt.core import Desktop, Circuit
 
 with Desktop(
-    specified_version="2022.2",
+    version="2022.2",
     non_graphical=False,
-    new_desktop_session=True,
+    new_desktop=True,
     close_on_exit=True,
     student_version=False,
 ):
@@ -259,7 +259,7 @@ with Desktop(
 
 from ansys.aedt.core import Circuit
 
-with Circuit(specified_version="2022.2", non_graphical=False) as circuit:
+with Circuit(version="2022.2", non_graphical=False) as circuit:
     ...
     # Any error here will be caught by Desktop.
     ...

README_CN.md

@@ -135,9 +135,9 @@ pip install pyaedt[all]
 from ansys.aedt.core import Desktop, Circuit
 
 with Desktop(
-    specified_version="2022.2",
+    version="2022.2",
     non_graphical=False,
-    new_desktop_session=True,
+    new_desktop=True,
     close_on_exit=True,
     student_version=False,
 ):
@@ -156,7 +156,7 @@ with Desktop(
 
 from ansys.aedt.core import Circuit
 
-with Circuit(specified_version="2022.2", non_graphical=False) as circuit:
+with Circuit(version="2022.2", non_graphical=False) as circuit:
     ...
     # Any error here will be caught by Desktop.
     ...

doc/changelog.d/7279.documentation.md

@@ -0,0 +1 @@
+Update parameter names from 'specified_version' to 'version' in multiple files

doc/source/API/Application.rst

@@ -40,9 +40,9 @@ Example with ``Desktop`` class explicit initialization:
     from ansys.aedt.core import launch_desktop, Circuit
 
     d = launch_desktop(
-        specified_version="2025.2",
+        version="2025.2",
         non_graphical=False,
-        new_desktop_session=True,
+        new_desktop=True,
         close_on_exit=True,
         student_version=False,
     )
@@ -59,9 +59,9 @@ Example with ``Desktop`` class implicit initialization:
     from ansys.aedt.core import Circuit
 
     circuit = Circuit(
-        specified_version="2025.2",
+        version="2025.2",
         non_graphical=False,
-        new_desktop_session=True,
+        new_desktop=True,
         close_on_exit=True,
         student_version=False,
     )

doc/source/API/CableModeling.rst

@@ -37,10 +37,10 @@ Cable bundle creation example:
     from ansys.aedt.core.modules.cable_modeling import Cable
 
     hfss = Hfss(
-        projectname=project_path,
-        specified_version="2025.2",
+        project=project_path,
+        version="2025.2",
         non_graphical=False,
-        new_desktop_session=True,
+        new_desktop=True,
         close_on_exit=True,
         student_version=False,
     )
@@ -76,10 +76,10 @@ Clock source creation example:
     from ansys.aedt.core.modules.cable_modeling import Cable
 
     hfss = Hfss(
-        projectname=project_path,
-        specified_version="2025.2",
+        project=project_path,
+        version="2025.2",
         non_graphical=False,
-        new_desktop_session=True,
+        new_desktop=True,
         close_on_exit=True,
         student_version=False,
     )
@@ -127,10 +127,10 @@ Cable harness creation example:
     from ansys.aedt.core.modules.cable_modeling import Cable
 
     hfss = Hfss(
-        projectname=project_path,
-        specified_version="2025.2",
+        project=project_path,
+        version="2025.2",
         non_graphical=False,
-        new_desktop_session=True,
+        new_desktop=True,
         close_on_exit=True,
         student_version=False,
     )

doc/source/API/Configuration.rst

@@ -40,10 +40,10 @@ the boundary fails to apply.
     from ansys.aedt.core import Hfss
 
     app = Hfss(
-        project_name="original_project",
-        specified_version="2025.2",
+        project="original_project",
+        version="2025.2",
         non_graphical=False,
-        new_desktop_session=True,
+        new_desktop=True,
         close_on_exit=True,
         student_version=False,
     )

doc/source/API/MaterialManagement.rst

@@ -29,9 +29,9 @@ This section describes all material-related classes and methods.
     from ansys.aedt.core import Hfss
 
     app = Hfss(
-        specified_version="2025.2",
+        version="2025.2",
         non_graphical=False,
-        new_desktop_session=True,
+        new_desktop=True,
         close_on_exit=True,
         student_version=False,
     )

doc/source/API/Mesh.rst

@@ -23,9 +23,9 @@ They are accessible through the mesh property:
     from ansys.aedt.core import Maxwell3d
 
     app = Maxwell3d(
-        specified_version="2025.2",
+        version="2025.2",
         non_graphical=False,
-        new_desktop_session=True,
+        new_desktop=True,
         close_on_exit=True,
         student_version=False,
     )

doc/source/API/Optimetrics.rst

@@ -8,9 +8,9 @@ optimetrics setups.
     from ansys.aedt.core import Hfss
 
     app = Hfss(
-        specified_version="2025.2",
+        version="2025.2",
         non_graphical=False,
-        new_desktop_session=True,
+        new_desktop=True,
         close_on_exit=True,
         student_version=False,
     )

doc/source/API/Primitive_Objects.rst

@@ -14,9 +14,9 @@ They are accessible through the ``modeler.objects`` property:
     from ansys.aedt.core import Hfss
 
     app = Hfss(
-        specified_version="2025.2",
+        version="2025.2",
         non_graphical=False,
-        new_desktop_session=True,
+        new_desktop=True,
         close_on_exit=True,
         student_version=False,
     )
@@ -79,9 +79,9 @@ They contain all getters and setters to simplify object manipulation.
     from ansys.aedt.core import Hfss
 
     app = Hfss(
-        specified_version="2025.2",
+        version="2025.2",
         non_graphical=False,
-        new_desktop_session=True,
+        new_desktop=True,
         close_on_exit=True,
         student_version=False,
     )
@@ -129,9 +129,9 @@ imported and used because it is made by static methods.
     from ansys.aedt.core import Hfss
 
     app = Hfss(
-        specified_version="2025.2",
+        version="2025.2",
         non_graphical=False,
-        new_desktop_session=True,
+        new_desktop=True,
         close_on_exit=True,
         student_version=False,
     )