Skip to content

Commit fec71a1

Browse files
changes in the result_key property method
1 parent f738317 commit fec71a1

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

src/ansys/dpf/core/data_sources.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -531,6 +531,19 @@ def result_key(self):
531531
str
532532
Result key.
533533
534+
Examples
535+
--------
536+
537+
>>> from ansys.dpf import core as dpf
538+
>>>
539+
>>> # Create the DataSources object
540+
>>> my_data_sources = dpf.DataSources()
541+
>>> # Define the path where the main result file can be found
542+
>>> my_data_sources.set_result_file_path(filepath='/tmp/file.rst', key='rst')
543+
>>> # Get the to the main result file
544+
>>> my_data_sources.result_key
545+
'rst'
546+
534547
"""
535548
return self._api.data_sources_get_result_key(self)
536549

0 commit comments

Comments
 (0)