Skip to content

Commit 2b29c99

Browse files
committed
Address docstring comments
1 parent a485b59 commit 2b29c99

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

python/arcticdb/version_store/library.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1030,13 +1030,15 @@ def write(
10301030
the default library configuration is True, otherwise it is False.
10311031
The library configuration can be modified via Arctic.modify_library_option(). Please refer to
10321032
https://docs.arcticdb.io/latest/api/arctic/#arcticdb.Arctic.modify_library_option for more details.
1033-
The data structure can be nested or a mix of lists and dictionaries.
1033+
The data structure can be nested or a mix of lists, dictionaries and tuples.
10341034
Example:
10351035
data = {"a": np.arange(5), "b": pd.DataFrame({"col": [1, 2, 3]})}
10361036
lib.write(symbol, data, recursive_normalizers=False) # ArcticUnsupportedDataTypeException will be thrown
10371037
lib.write(symbol, data, recursive_normalizers=True) # The data will be successfully written
10381038
ac.modify_library_option(lib, ModifiableLibraryOption.RECURSIVE_NORMALIZERS, True)
10391039
lib.write(symbol, data) # The data will be successfully written
1040+
Please refer to https://docs.arcticdb.io/latest/notebooks/arcticdb_demo_recursive_normalizers for more details
1041+
of this feature.
10401042
10411043
Returns
10421044
-------
@@ -1072,7 +1074,7 @@ def write(
10721074
if is_recursive_normalizers_enabled:
10731075
if staged:
10741076
raise ArcticUnsupportedDataTypeException(
1075-
"Staged data must be of a type that can be natively normalized"
1077+
"Staged data cannot be natively normalized. The recursive normalizer is enabled but is not allowed to work on staged data."
10761078
)
10771079
else:
10781080
raise ArcticUnsupportedDataTypeException(
@@ -1126,6 +1128,7 @@ def write_pickle(
11261128
See documentation on `write`.
11271129
recursive_normalizers: bool, default None
11281130
See documentation on `write`.
1131+
If enabled, attempts to recursively normalize data before falling back to pickling.
11291132
If the leaf nodes cannot be natively normalized, they will be pickled,
11301133
resulting in the overall data being recursively normalized and partially pickled.
11311134
Example:

0 commit comments

Comments
 (0)