Skip to content

Commit 2cc7c15

Browse files
updates in the DataSources api reference
1 parent 653b48f commit 2cc7c15

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

src/ansys/dpf/core/data_sources.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -142,9 +142,9 @@ def set_result_file_path(
142142
143143
Parameters
144144
----------
145-
filepath :
145+
filepath:
146146
Path to the result file.
147-
key :
147+
key:
148148
Extension of the file, which is used as a key for choosing the correct
149149
plugin when a result is requested by an operator. The default is ``""``,
150150
in which case the key is found directly.
@@ -191,7 +191,7 @@ def guess_result_key(filepath: str) -> str:
191191
192192
Returns
193193
-------
194-
str
194+
str:
195195
Extension key name
196196
197197
Examples
@@ -227,12 +227,12 @@ def guess_second_key(filepath: str) -> str:
227227
228228
Parameters
229229
----------
230-
filepath :
230+
filepath:
231231
Path to the file.
232232
233233
Returns
234234
-------
235-
str
235+
str:
236236
First extension key name
237237
238238
Examples
@@ -317,9 +317,9 @@ def add_file_path(
317317
318318
Parameters
319319
----------
320-
filepath :
320+
filepath:
321321
Path of the file.
322-
key :
322+
key:
323323
Extension of the file, which is used as a key for choosing the correct
324324
plugin when a result is requested by an operator. The default is ``""``,
325325
in which case the key is found directly.
@@ -538,7 +538,7 @@ def result_key(self) -> str:
538538
539539
Returns
540540
-------
541-
str
541+
str:
542542
Result key.
543543
544544
Examples
@@ -563,7 +563,7 @@ def result_files(self):
563563
564564
Returns
565565
----------
566-
list
566+
list:
567567
List of result files.
568568
569569
Examples
@@ -688,7 +688,7 @@ def __str__(self):
688688
689689
Returns
690690
-------
691-
str
691+
str:
692692
Description of the entity.
693693
"""
694694
from ansys.dpf.core.core import _description

0 commit comments

Comments
 (0)