Skip to content

Commit f3a08fa

Browse files
committed
fix docs
1 parent 7f74df3 commit f3a08fa

File tree

3 files changed

+59
-71
lines changed

3 files changed

+59
-71
lines changed

pyaedt/maxwell.py

+1-7
Original file line numberDiff line numberDiff line change
@@ -2228,11 +2228,6 @@ def assign_impedance(
22282228
impedance : str, optional
22292229
Name of the impedance. The default is ``None`` in which case a unique name is chosen.
22302230
2231-
Returns
2232-
-------
2233-
:class:`pyaedt.modules.Boundary.BoundaryObject`
2234-
Boundary object if successful, ``False`` otherwise.
2235-
22362231
References
22372232
----------
22382233
@@ -2252,9 +2247,8 @@ def assign_impedance(
22522247
22532248
Returns
22542249
-------
2255-
<class 'pyaedt.modules.Boundary.BoundaryObject'>
2250+
:class:`pyaedt.modules.Boundary.BoundaryObject`
22562251
Boundary object if successful, ``False`` otherwise.
2257-
22582252
"""
22592253

22602254
if self.solution_type in [

pyaedt/mechanical.py

+32-34
Original file line numberDiff line numberDiff line change
@@ -636,41 +636,39 @@ def assign_heat_generation(self, objects_list, value, boundary_name=""):
636636
def create_setup(self, setupname="MySetupAuto", setuptype=None, **kwargs):
637637
"""Create an analysis setup for Mechanical.
638638
639-
Optional arguments are passed along with ``setuptype`` and ``setupname``. Keyword
640-
names correspond to the ``setuptype``
641-
corresponding to the native AEDT API. The list of
642-
keywords here is not exhaustive.
643-
644-
645-
Parameters
646-
----------
647-
setuptype : int, str, optional
648-
Type of the setup. Options are ``"IcepakSteadyState"`` and
649-
``"IcepakTransient"``. The default is ``"IcepakSteadyState"``.
650-
setupname : str, optional
651-
Name of the setup. The default is ``"Setup1"``.
652-
**kwargs : dict, optional
653-
Available keys depend on the setup chosen.
654-
For more information, see :doc:`../SetupTemplatesMechanical`.
655-
656-
Returns
657-
-------
658-
:class:`pyaedt.modules.SolveSetup.SetupHFSS`
659-
Solver Setup object.
660-
661-
References
662-
----------
663-
664-
>>> oModule.InsertSetup
665-
666-
Examples
667-
--------
668-
669-
>>> from pyaedt import Mechanical
670-
>>> app = Mechanical()
671-
>>> app.create_setup(setup_name="Setup1",MaxModes=6)
672-
)
639+
Optional arguments are passed along with ``setuptype`` and ``setupname``. Keyword
640+
names correspond to the ``setuptype``
641+
corresponding to the native AEDT API. The list of
642+
keywords here is not exhaustive.
643+
644+
645+
Parameters
646+
----------
647+
setuptype : int, str, optional
648+
Type of the setup. Options are ``"IcepakSteadyState"`` and
649+
``"IcepakTransient"``. The default is ``"IcepakSteadyState"``.
650+
setupname : str, optional
651+
Name of the setup. The default is ``"Setup1"``.
652+
**kwargs : dict, optional
653+
Available keys depend on the setup chosen.
654+
For more information, see :doc:`../SetupTemplatesMechanical`.
655+
656+
Returns
657+
-------
658+
:class:`pyaedt.modules.SolveSetup.SetupHFSS`
659+
Solver Setup object.
660+
661+
References
662+
----------
663+
664+
>>> oModule.InsertSetup
665+
666+
Examples
667+
--------
673668
669+
>>> from pyaedt import Mechanical
670+
>>> app = Mechanical()
671+
>>> app.create_setup(setup_name="Setup1",MaxModes=6)
674672
"""
675673
if setuptype is None:
676674
setuptype = self.design_solutions.default_setup

pyaedt/q3d.py

+26-30
Original file line numberDiff line numberDiff line change
@@ -2496,42 +2496,38 @@ def toggle_conductor_type(self, conductor_name, new_type):
24962496
def create_setup(self, setupname="MySetupAuto", setuptype=None, **kwargs):
24972497
"""Create an analysis setup for 2D Extractor.
24982498
2499-
Optional arguments are passed along with the ``setuptype`` and ``setupname``
2500-
parameters. Keyword names correspond to the ``setuptype``
2501-
corresponding to the native AEDT API. The list of
2502-
keywords here is not exhaustive.
2499+
Optional arguments are passed along with the ``setuptype`` and ``setupname``
2500+
parameters. Keyword names correspond to the ``setuptype``
2501+
corresponding to the native AEDT API. The list of
2502+
keywords here is not exhaustive.
25032503
2504+
Parameters
2505+
----------
2506+
setuptype : int, str, optional
2507+
Type of the setup. Options are "IcepakSteadyState"
2508+
and "IcepakTransient". The default is "IcepakSteadyState".
2509+
setupname : str, optional
2510+
Name of the setup. The default is "Setup1".
2511+
**kwargs : dict, optional
2512+
Available keys depend on the setup chosen.
2513+
For more information, see :doc:`../SetupTemplatesQ3D`.
25042514
2505-
Parameters
2506-
----------
2507-
setuptype : int, str, optional
2508-
Type of the setup. Options are "IcepakSteadyState"
2509-
and "IcepakTransient". The default is "IcepakSteadyState".
2510-
setupname : str, optional
2511-
Name of the setup. The default is "Setup1".
2512-
**kwargs : dict, optional
2513-
Available keys depend on the setup chosen.
2514-
For more information, see :doc:`../SetupTemplatesQ3D`.
2515-
2516-
2517-
Returns
2518-
-------
2519-
:class:`pyaedt.modules.SolveSetup.SetupHFSS`
2520-
Solver Setup object.
2521-
2522-
References
2523-
----------
2515+
Returns
2516+
-------
2517+
:class:`pyaedt.modules.SolveSetup.SetupHFSS`
2518+
Solver Setup object.
25242519
2525-
>>> oModule.InsertSetup
2520+
References
2521+
----------
25262522
2527-
Examples
2528-
--------
2523+
>>> oModule.InsertSetup
25292524
2530-
>>> from pyaedt import Q2d
2531-
>>> app = Q2d()
2532-
>>> app.create_setup(setup_name="Setup1",RLDataBlock__MinPass=2)
2533-
)
2525+
Examples
2526+
--------
25342527
2528+
>>> from pyaedt import Q2d
2529+
>>> app = Q2d()
2530+
>>> app.create_setup(setup_name="Setup1",RLDataBlock__MinPass=2)
25352531
"""
25362532
if setuptype is None:
25372533
setuptype = self.design_solutions.default_setup

0 commit comments

Comments
 (0)