Skip to content

Commit

Permalink
update docstrings with wrong default value stated (#1552)
Browse files Browse the repository at this point in the history
  • Loading branch information
@haakonvt
haakonvt authored Dec 15, 2023
1 parent 3eb3bbe commit 1aebfc3
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 16 deletions.
8 changes: 4 additions & 4 deletions cognite/client/data_classes/_base.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ def dump(self, camel_case: bool = True) -> dict[str, Any]:
"""Dump the instance into a json serializable Python data type.
Args:
camel_case (bool): Use camelCase for attribute names. Defaults to False.
camel_case (bool): Use camelCase for attribute names. Defaults to True.
Returns:
dict[str, Any]: A dictionary representation of the instance.
Expand Down Expand Up @@ -130,7 +130,7 @@ def dump(self, camel_case: bool = True) -> dict[str, Any]:
"""Dump the instance into a json serializable Python data type.
Args:
camel_case (bool): Use camelCase for attribute names. Defaults to False.
camel_case (bool): Use camelCase for attribute names. Defaults to True.
Returns:
dict[str, Any]: A dictionary representation of the instance.
Expand Down Expand Up @@ -296,7 +296,7 @@ def dump(self, camel_case: bool = True) -> list[dict[str, Any]]:
"""Dump the instance into a json serializable Python data type.
Args:
camel_case (bool): Use camelCase for attribute names. Defaults to False.
camel_case (bool): Use camelCase for attribute names. Defaults to True.
Returns:
list[dict[str, Any]]: A list of dicts representing the instance.
Expand Down Expand Up @@ -573,7 +573,7 @@ def dump(self, camel_case: bool = True) -> dict[str, Any]:
"""Dump the instance into a json serializable Python data type.
Args:
camel_case (bool): Use camelCase for attribute names. Defaults to False.
camel_case (bool): Use camelCase for attribute names. Defaults to True.
Returns:
dict[str, Any]: A dictionary representation of the instance.
Expand Down
2 changes: 1 addition & 1 deletion cognite/client/data_classes/annotation_types/primitives.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ def dump(self, camel_case: bool = True) -> dict[str, Any]:
"""Dump the instance into a json serializable Python data type.
Args:
camel_case (bool): Use camelCase for attribute names. Defaults to False.
camel_case (bool): Use camelCase for attribute names. Defaults to True.
Returns:
dict[str, Any]: A dictionary representation of the instance.
Expand Down
6 changes: 3 additions & 3 deletions cognite/client/data_classes/datapoints.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ def dump(self, camel_case: bool = True, convert_timestamps: bool = False) -> dic
"""Dump the DatapointsArray into a json serializable Python data type.
Args:
camel_case (bool): Use camelCase for attribute names. Default: False.
camel_case (bool): Use camelCase for attribute names. Defaults to True.
convert_timestamps (bool): Convert timestamps to ISO 8601 formatted strings. Default: False (returns as integer, milliseconds since epoch)
Returns:
Expand Down Expand Up @@ -522,7 +522,7 @@ def dump(self, camel_case: bool = True) -> dict[str, Any]:
"""Dump the datapoints into a json serializable Python data type.
Args:
camel_case (bool): Use camelCase for attribute names. Defaults to False.
camel_case (bool): Use camelCase for attribute names. Defaults to True.
Returns:
dict[str, Any]: A dictionary representing the instance.
Expand Down Expand Up @@ -789,7 +789,7 @@ def dump(self, camel_case: bool = True, convert_timestamps: bool = False) -> lis
"""Dump the instance into a json serializable Python data type.
Args:
camel_case (bool): Use camelCase for attribute names. Default: False.
camel_case (bool): Use camelCase for attribute names. Defaults to True.
convert_timestamps (bool): Convert timestamps to ISO 8601 formatted strings. Default: False (returns as integer, milliseconds since epoch)
Returns:
Expand Down
2 changes: 1 addition & 1 deletion cognite/client/data_classes/sequences.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,7 @@ def dump(self, camel_case: bool = True) -> dict[str, Any]:
"""Dump the sequence data into a json serializable Python data type.
Args:
camel_case (bool): Use camelCase for attribute names. Defaults to False.
camel_case (bool): Use camelCase for attribute names. Defaults to True.
Returns:
dict[str, Any]: A dictionary representing the instance.
Expand Down
4 changes: 2 additions & 2 deletions cognite/client/data_classes/templates.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ def dump(self, camel_case: bool = True) -> dict[str, Any]:
"""Dump the instance into a json serializable Python data type.
Args:
camel_case (bool): Use camelCase for attribute names. Defaults to False.
camel_case (bool): Use camelCase for attribute names. Defaults to True.
Returns:
dict[str, Any]: A dictionary representation of the instance.
Expand Down Expand Up @@ -371,7 +371,7 @@ def dump(self, camel_case: bool = True) -> dict[str, Any]:
"""Dump the instance into a json serializable Python data type.
Args:
camel_case (bool): Use camelCase for attribute names. Defaults to False.
camel_case (bool): Use camelCase for attribute names. Defaults to True.
Returns:
dict[str, Any]: A dictionary representation of the instance.
Expand Down
6 changes: 3 additions & 3 deletions cognite/client/data_classes/transformations/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ def dump(self, camel_case: bool = True) -> dict[str, Any]:
"""Dump the instance into a json serializable Python data type.
Args:
camel_case (bool): Use camelCase for attribute names. Defaults to False.
camel_case (bool): Use camelCase for attribute names. Defaults to True.
Returns:
dict[str, Any]: A dictionary representation of the instance.
Expand Down Expand Up @@ -355,7 +355,7 @@ def dump(self, camel_case: bool = True) -> dict[str, Any]:
"""Dump the instance into a json serializable Python data type.
Args:
camel_case (bool): Use camelCase for attribute names. Defaults to False.
camel_case (bool): Use camelCase for attribute names. Defaults to True.
Returns:
dict[str, Any]: A dictionary representation of the instance.
Expand Down Expand Up @@ -597,7 +597,7 @@ def dump(self, camel_case: bool = True) -> dict[str, Any]:
"""Dump the instance into a json serializable Python data type.
Args:
camel_case (bool): Use camelCase for attribute names. Defaults to False.
camel_case (bool): Use camelCase for attribute names. Defaults to True.
Returns:
dict[str, Any]: A dictionary representation of the instance.
Expand Down
4 changes: 2 additions & 2 deletions cognite/client/data_classes/transformations/common.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ def dump(self, camel_case: bool = True) -> dict[str, Any]:
"""Dump the instance into a json serializable Python data type.
Args:
camel_case (bool): Use camelCase for attribute names. Defaults to False.
camel_case (bool): Use camelCase for attribute names. Defaults to True.
Returns:
dict[str, Any]: A dictionary representation of the instance.
Expand Down Expand Up @@ -375,7 +375,7 @@ def dump(self, camel_case: bool = True) -> dict[str, Any]:
"""Dump the instance into a json serializable Python data type.
Args:
camel_case (bool): Use camelCase for attribute names. Defaults to False.
camel_case (bool): Use camelCase for attribute names. Defaults to True.
Returns:
dict[str, Any]: A dictionary representation of the instance.
Expand Down

0 comments on commit 1aebfc3

Please sign in to comment.