Fixed Docstring #3970 (#3985)

* Fixed Docstring #3970

* Update pyaedt/maxwell.py

Co-authored-by: Maxime Rey <[email protected]>

* Update pyaedt/maxwell.py

Extra Line

Co-authored-by: Samuel Lopez <[email protected]>

* Update pyaedt/maxwell.py

Unneeded Indentation

Co-authored-by: Samuel Lopez <[email protected]>

* Update pyaedt/maxwell.py

Co-authored-by: Samuel Lopez <[email protected]>

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update maxwell.py

MIssing Maxwell solver types added

* Update maxwell.py

Spread Maxwell solver names over two lines to obey line length limit

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update pyaedt/maxwell.py

Hi, There was no deep thought behind the dash next to the colon. 
I've removed it, sounds like text will now be consistent with other parts of docs

Co-authored-by: SMoraisAnsys <[email protected]>

* Update pyaedt/maxwell.py

The word 'Depending' was proposed instead of 'Based'

Co-authored-by: Kathy Pippert <[email protected]>

* Update pyaedt/maxwell.py

Solvers no longer grouped in terms of Magnetic and Electric solvers but now alphabetized and with double backticks and quotation marks applied.

Co-authored-by: Kathy Pippert <[email protected]>

* Fixed Docstring #3970 and removed reference to HFSS

* Fixed Docstring #3970 and removed reference to HFSS

* Title style reverted to Sentence-style capitalization.

* fix doc

* fix doc

* Reference to AC and DC Conduction templates removed

* remove blank line

---------

Co-authored-by: Maxime Rey <[email protected]>
Co-authored-by: gmalinve <[email protected]>
Co-authored-by: Samuel Lopez <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: SMoraisAnsys <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>
Co-authored-by: Giulia Malinverno <[email protected]>

doc/source/API/SetupTemplatesMaxwell.rst

@@ -8,19 +8,16 @@ You can edit a setup after it is created. Here is an example:
 
 .. code:: python
 
-    from pyaedt import Hfss
+    from pyaedt import Maxwell3d
 
-    hfss = Hfss()
+    Maxwell3d = Maxwell3d ()
     # Any property of this setup can be found on this page.
-    setup = hfss.create_setup()
-    setup.props["AdaptMultipleFreqs"] = True
-    setup.update()
-
-
+    setup = Maxwell3d.create_setup ()
+    setup.props["MaximumPasses"] = 5
+    setup.update ()
 
 .. pprint:: pyaedt.modules.SetupTemplates.MaxwellTransient
 .. pprint:: pyaedt.modules.SetupTemplates.Magnetostatic
 .. pprint:: pyaedt.modules.SetupTemplates.Electrostatic
 .. pprint:: pyaedt.modules.SetupTemplates.EddyCurrent
 .. pprint:: pyaedt.modules.SetupTemplates.ElectricTransient
-

pyaedt/maxwell.py

@@ -1946,21 +1946,18 @@ def edit_external_circuit(self, netlist_file_path, schematic_design_name):
     @pyaedt_function_handler()
     def create_setup(self, setupname="MySetupAuto", setuptype=None, **kwargs):
         """Create an analysis setup for Maxwell 3D or 2D.
-        Optional arguments are passed along with ``setuptype`` and ``setupname``.  Keyword
-        names correspond to the ``setuptype``
-        corresponding to the native AEDT API.  The list of
-        keywords here is not exhaustive.
 
-        .. note::
-           This method overrides the ``Analysis.setup()`` method for the HFSS app.
+        Optional arguments are passed along with ``setuptype`` and ``setupname``.
+        Keyword names correspond to the ``setuptype`` corresponding to the native AEDT API.
+        The list of keywords here is not exhaustive.
 
         Parameters
         ----------
         setuptype : int, str, optional
-            Type of the setup. Based on the solution type, options are
-            ``"HFSSDrivenAuto"``, ``"HFSSDrivenDefault"``,
-            ``"HFSSEigen"``, ``"HFSSTransient"`` and ``"HFSSSBR"``.
-            The default is ``"HFSSDrivenAuto"``.
+            Type of the setup. Depending on the solution type, options are
+            ``"AC Conduction"``, ``"DC Conduction"``, ``"EddyCurrent"``,
+            ``"Electric Transient"``, ``"Electrostatic"``, ``"Magnetostatic"``,
+            and ``Transient"``.
         setupname : str, optional
             Name of the setup. The default is ``"Setup1"``.
         **kwargs : dict, optional
@@ -1974,15 +1971,13 @@ def create_setup(self, setupname="MySetupAuto", setuptype=None, **kwargs):
 
         References
         ----------
-
         >>> oModule.InsertSetup
 
         Examples
         --------
-
         >>> from pyaedt import Maxwell3d
         >>> app = Maxwell3d()
-        >>> app.create_setup(setupname="Setup1", setuptype="EddyCurrent", MaximumPasses=10,PercentError=2 )
+        >>> app.create_setup(setupname="My_Setup", setuptype="EddyCurrent", MaximumPasses=10, PercentError=2 )
 
         """
         if setuptype is None: