updates in the DataSources api reference

Author: luisaFelixSalles

src/ansys/dpf/core/data_sources.py

@@ -200,12 +200,17 @@ def guess_result_key(filepath: str) -> str:
         Gives the result key for the result file of the given path
 
         >>> from ansys.dpf import core as dpf
+        >>> from ansys.dpf.core import examples
         >>>
         >>> # Create the DataSources object
         >>> my_data_sources = dpf.DataSources()
+        >>> # Download the result files
+        >>> path = examples.find_simple_bar()
+        >>> # Define the path where the main result file can be found
+        >>> my_data_sources.set_result_file_path(filepath=path)
         >>> # Define the extension key for the file in the given path
-        >>> my_file_key = my_data_sources.guess_result_key(filepath=r'file.extension1234')
-        'extension1234'
+        >>> my_file_key = my_data_sources.guess_result_key(filepath=path)
+        'rst'
 
         """
         result_keys = ["d3plot", "binout"]
@@ -241,11 +246,13 @@ def guess_second_key(filepath: str) -> str:
         >>> paths = examples.download_fluent_axial_comp()
         >>> # Create the DataSources object
         >>> my_data_sources = dpf.DataSources()
-        >>> # Define the extensions keys for the files in the given paths
+        >>> # Define the path where the main result file can be found
         >>> # We see that the paths are given in a dictionary.
         >>> # So to choose the correct file you need to give as an argument:
         >>> # - the list label
         >>> # - the file index in that list
+        >>> my_data_sources.set_result_file_path(filepath=paths['cas'][0])
+        >>> # Define the extension key for the file in the given path
         >>> my_file_key = my_data_sources.guess_second_key(filepath=paths['cas'][0])
         'cas'
 
@@ -383,7 +390,7 @@ def add_domain_file_path(
         >>> # Define the path where the main result data can be found and specify its domain
         >>> my_data_sources.set_domain_result_file_path(path='/tmp/ds.cas', key='cas', domain_id=1)
         >>> # Add the additional result data to the DataSources object and specify its domain
-        >>> my_data_sources.add_domain_file_path(path='/tmp/ds.dat', key="dat", domain_id=1)
+        >>> my_data_sources.add_domain_file_path(filepath='/tmp/ds.dat', key="dat", domain_id=1)
 
         """
         # The filename needs to be a fully qualified file name
@@ -602,7 +609,7 @@ def result_files(self):
         >>>
         >>> # Get the path to the main result file of the main DataSources object
         >>> my_data_sources.result_files
-        [..\\.venv\\Lib\\site-packages\\ansys\\dpf\\core\\examples\\result_files\\msup\\file.rfrq']
+        ['../site-packages/ansys/dpf/core/examples/result_files/msup/file.rfrq']
 
         - If you are checking the DataSources object created to define the upstream data, only the first one is listed.