Skip to content

Commit

Permalink
Improved documentation methods (#2601)
Browse files Browse the repository at this point in the history
Co-authored-by: maxcapodi78 <Shark78>
  • Loading branch information
maxcapodi78 committed Mar 9, 2023
1 parent fe7f0a2 commit ae9203f
Show file tree
Hide file tree
Showing 3 changed files with 157 additions and 59 deletions.
7 changes: 5 additions & 2 deletions pyaedt/modeler/cad/object3d.py
Original file line number Diff line number Diff line change
Expand Up @@ -258,15 +258,18 @@ def plot(self, show=True):

@pyaedt_function_handler()
def export_image(self, file_path=None):
"""Export the model to path.
"""Export the current object to a specified file path.
.. note::
Works from AEDT 2021.2 in CPython only. PyVista has to be installed.
Parameters
----------
file_path : str, optional
File name with full path. If `None` Project directory will be used.
File name with full path. If `None` the exported image will be a ``png`` file that
will be saved in ``working_directory``.
To access the ``working_directory`` the use ``app.working_directory`` property.
Returns
-------
Expand Down

0 comments on commit ae9203f

Please sign in to comment.