Skip to content

Commit 0da0cfe

Browse files
authored
improve documentation (#146)
1 parent 20858a7 commit 0da0cfe

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

cacholote/config.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,11 +143,13 @@ class set:
143143
sqlalchemy.sessionamaker, mutually exclusive with cache_db_urlpath and create_engine_kwargs
144144
cache_files_urlpath: str, default:"/system_tmp_dir/cacholote/cache_files"
145145
URL for cache files (protocol://location).
146-
cache_files_storage_options: dict, default: {}
147-
``fsspec`` storage options for storing cache files.
148146
cache_files_urlpath_readonly: str, None, default: None
149147
URL for cache files accessible in read-only mode.
150148
None: same as ``cache_files_urlpath``
149+
cache_files_storage_options: dict, default: {}
150+
``fsspec`` storage options for storing cache files.
151+
cache_files_protocol: str, None, default: None
152+
To override the protocol specifier in `cache_files_urlpath`.
151153
xarray_cache_type: {"application/netcdf", "application/x-grib", "application/vnd+zarr"}, \
152154
default: "application/netcdf"
153155
Type for ``xarray`` cache files.
@@ -162,6 +164,8 @@ class set:
162164
Note that existing tags are overwritten.
163165
return_cache_entry: bool, default: False
164166
Whether to return the cache database entry rather than decoded results.
167+
logger: structlog.BoundLogger
168+
Logger to use.
165169
lock_timeout: float, optional, default: None
166170
Time to wait before raising an error if a cache file is locked.
167171
context: Context, optional, default: None

0 commit comments

Comments
 (0)