Skip to content

Commit 804d2a5

Browse files
committed
Address docstring comments
1 parent 97650b1 commit 804d2a5

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
@@ -999,13 +999,15 @@ def write(
999999
the default library configuration is True, otherwise it is False.
10001000
The library configuration can be modified via Arctic.modify_library_option(). Please refer to
10011001
https://docs.arcticdb.io/latest/api/arctic/#arcticdb.Arctic.modify_library_option for more details.
1002-
The data structure can be nested or a mix of lists and dictionaries.
1002+
The data structure can be nested or a mix of lists, dictionaries and tuples.
10031003
Example:
10041004
data = {"a": np.arange(5), "b": pd.DataFrame({"col": [1, 2, 3]})}
10051005
lib.write(symbol, data, recursive_normalizers=False) # ArcticUnsupportedDataTypeException will be thrown
10061006
lib.write(symbol, data, recursive_normalizers=True) # The data will be successfully written
10071007
ac.modify_library_option(lib, ModifiableLibraryOption.RECURSIVE_NORMALIZERS, True)
10081008
lib.write(symbol, data) # The data will be successfully written
1009+
Please refer to https://docs.arcticdb.io/latest/notebooks/arcticdb_demo_recursive_normalizers for more details
1010+
of this feature.
10091011
10101012
Returns
10111013
-------
@@ -1041,7 +1043,7 @@ def write(
10411043
if is_recursive_normalizers_enabled:
10421044
if staged:
10431045
raise ArcticUnsupportedDataTypeException(
1044-
"Staged data must be of a type that can be natively normalized"
1046+
"Staged data cannot be natively normalized. The recursive normalizer is enabled but is not allowed to work on staged data."
10451047
)
10461048
else:
10471049
raise ArcticUnsupportedDataTypeException(
@@ -1095,6 +1097,7 @@ def write_pickle(
10951097
See documentation on `write`.
10961098
recursive_normalizers: bool, default None
10971099
See documentation on `write`.
1100+
If enabled, attempts to recursively normalize data before falling back to pickling.
10981101
If the leaf nodes cannot be natively normalized, they will be pickled,
10991102
resulting in the overall data being recursively normalized and partially pickled.
11001103
Example:

0 commit comments

Comments
 (0)