Skip to content

Commit

Permalink
change doc
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinBelthle committed Jul 10, 2024
1 parent d77b6d7 commit b0b2ee2
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion antarest/study/common/studystorage.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ def get(
metadata: study
url: path data inside study to reach
depth: tree depth to reach after reach data path
format: Indicates the file return format. Can be 'json', 'arrow' or None. If so, the file will be returned as is.
format: Indicates the file return format. Can be 'json', 'arrow' or None. If None, the file will be returned as is.
Returns: study data formatted in json
Expand Down
2 changes: 1 addition & 1 deletion antarest/study/service.py
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ def get(self, uuid: str, url: str, depth: int, params: RequestParameters, format
uuid: study uuid
url: route to follow inside study structure
depth: depth to expand tree when route matched
format: Indicates the file return format. Can be 'json', 'arrow' or None. If so, the file will be returned as is.
format: Indicates the file return format. Can be 'json', 'arrow' or None. If None, the file will be returned as is.
params: request parameters
Returns: data study formatted in json
Expand Down
2 changes: 1 addition & 1 deletion antarest/study/storage/abstract_storage_service.py
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ def get(
metadata: study
url: path data inside study to reach
depth: tree depth to reach after reach data path
format: Indicates the file return format. Can be 'json', 'arrow' or None. If so, the file will be returned as is.
format: Indicates the file return format. Can be 'json', 'arrow' or None. If None, the file will be returned as is.
use_cache: indicate if the cache must be used
Returns: study data formatted in json
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,7 @@ def get(
metadata: study
url: path data inside study to reach
depth: tree depth to reach after reach data path
format: Indicates the file return format. Can be either Can be 'json', 'arrow' or None. If so, the file will be returned as is.
format: Indicates the file return format. Can be either Can be 'json', 'arrow' or None. If None, the file will be returned as is.
use_cache: indicate if cache should be used
Returns: study data formatted in json
Expand Down

0 comments on commit b0b2ee2

Please sign in to comment.