updates in the DataSources api reference

Author: luisaFelixSalles

src/ansys/dpf/core/data_sources.py

@@ -63,11 +63,11 @@ class DataSources:
 
     Parameters
     ----------
-    result_path :
+    result_path
         Path of the result. The default is ``None``.
-    data_sources :
+    data_sources
         gRPC data sources message. The default is ``None``.
-    server :
+    server
         Server with the channel connected to the remote or local instance. The
         default is ``None``, in which case an attempt is made to use the global
         server.
@@ -142,9 +142,9 @@ def set_result_file_path(
 
         Parameters
         ----------
-        filepath :
+        filepath
             Path to the result file.
-        key :
+        key
             Extension of the file, which is used as a key for choosing the correct
             plugin when a result is requested by an operator. The default is ``""``,
             in which case the key is found directly.
@@ -186,12 +186,12 @@ def guess_result_key(filepath: str) -> str:
 
         Parameters
         ----------
-        filepath :
+        filepath
             Path to the file.
 
         Returns
         -------
-        str :
+        str
             Extension key name
 
         Examples
@@ -227,12 +227,12 @@ def guess_second_key(filepath: str) -> str:
 
         Parameters
         ----------
-        filepath :
+        filepath
             Path to the file.
 
         Returns
         -------
-        str :
+        str
             First extension key name
 
         Examples
@@ -275,11 +275,11 @@ def set_domain_result_file_path(
 
         Parameters
         ----------
-        path :
+        path
             Path to the file.
-        domain_id :
+        domain_id
             Domain ID for the distributed files.
-        key :
+        key
             Key to associate to the file.
 
         Examples
@@ -316,15 +316,15 @@ def add_file_path(
 
         Parameters
         ----------
-        filepath :
+        filepath
             Path of the file.
-        key :
+        key
             Extension of the file, which is used as a key for choosing the correct
             plugin when a result is requested by an operator. The default is ``""``,
             in which case the key is found directly.
-        is_domain :
+        is_domain
             Whether the file path is the domain path. The default is ``False``.
-        domain_id :
+        domain_id
             Domain ID for the distributed files. The default is ``0``. For this
             parameter to be taken into account, ``domain_path=True`` must be set.
 
@@ -369,12 +369,12 @@ def add_domain_file_path(
 
         Parameters
         ----------
-        filepath :
+        filepath
             Path of the file.
-        key :
+        key
             Extension of the file, which is used as a key for choosing the correct
             plugin when a result is requested by an operator.
-        domain_id :
+        domain_id
             Domain ID for the distributed files.
 
         Examples
@@ -413,13 +413,13 @@ def add_file_path_for_specified_result(
 
         Parameters
         ----------
-        filepath :
+        filepath
             Path of the file.
-        key :
+        key
             Extension of the file, which is used as a key for choosing the correct
             plugin when a result is requested by an operator. The default is ``""``,
             in which case the key is found directly.
-        result_key :
+        result_key
             Extension of the results file that the specified file path belongs to.
             The default is ``""``, in which case the key is found directly.
 
@@ -443,10 +443,10 @@ def add_upstream(
 
         Parameters
         ----------
-        upstream_data_sources :
+        upstream_data_sources
             Set of paths creating an upstream for recursive workflows.
 
-        result_key :
+        result_key
             Extension of the result file group with which this upstream belongs
 
         Examples
@@ -489,10 +489,10 @@ def add_upstream_for_domain(self, upstream_data_sources: DataSources, domain_id:
 
         Parameters
         ----------
-        upstream_data_sources :
+        upstream_data_sources
             Set of paths creating an upstream for recursive workflows.
 
-        domain_id :
+        domain_id
             Domain id for distributed files.
 
         Examples
@@ -657,10 +657,10 @@ def register_namespace(self, result_key: str, namespace: str):
 
         Parameters
         ----------
-        result_key :
+        result_key
             Extension of the file, which is used as a key for choosing the correct
             plugin when a result is requested by an operator.
-        namespace :
+        namespace
             Namespace to associate the file extension to.
 
         Notes