Skip to content

Commit a5d1975

Browse files
style: update docstring of functions with default arguments
Co-Authored-By: nicolasservel <nico.servel@gmail.com>
1 parent 2c548dc commit a5d1975

File tree

3 files changed

+3
-4
lines changed

3 files changed

+3
-4
lines changed

dataikuapi/dss/macro.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ def run(self, params=None, admin_params=None, wait=True):
3939
4040
:param dict params: parameters to the macro run (defaults to `{}`)
4141
:param dict admin_params: admin parameters to the macro run (if the authentication of
42-
the api client does not cover admin rights, they are ignored, default to `{}`)
42+
the api client does not cover admin rights, they are ignored, defaults to `{}`)
4343
:param wait: if True, the call blocks until the run is finished
4444
:returns: a run identifier to use to abort or retrieve results
4545
"""
@@ -92,4 +92,3 @@ def get_result(self, run_id, as_type=None):
9292
else:
9393
return resp.raw
9494

95-

dataikuapi/dss/project.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -705,7 +705,7 @@ def create_scenario(self, scenario_name, type, definition=None):
705705
(although this is strongly recommended)
706706
:param str type: The type of the scenario. MUst be one of 'step_based' or 'custom_python'
707707
:param dict definition: the JSON definition of the scenario. Use ``get_definition(with_status=False)`` on an
708-
existing ``DSSScenario`` object in order to get a sample definition object (defaults to `{}`)
708+
existing ``DSSScenario`` object in order to get a sample definition object (defaults to `{'params': {}}`)
709709
710710
:returns: a :class:`.scenario.DSSScenario` handle to interact with the newly-created scenario
711711
"""

dataikuapi/dssclient.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -795,7 +795,7 @@ def catalog_index_connections(self, connection_names=None, all_connections=False
795795
Triggers an indexing of multiple connections in the data catalog
796796
797797
:param list connection_names: list of connections to index, ignored if `all_connections=True` (defaults to `[]`)
798-
:param bool all_connections: index all connections, (defaults to `False`)
798+
:param bool all_connections: index all connections (defaults to `False`)
799799
"""
800800
if connection_names is None:
801801
connection_names = []

0 commit comments

Comments
 (0)