Skip to content

Commit 18ff0df

Browse files
committed
adds docstring
1 parent b0da856 commit 18ff0df

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

src/DatasetAPI/Datasets.jl

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -407,10 +407,21 @@ end
407407

408408

409409
"""
410-
open_dataset(g; driver=:all)
410+
open_dataset(g; skip_keys=(), driver=:all)
411411
412412
Open the dataset at `g` with the given `driver`.
413413
The default driver will search for available drivers and tries to detect the useable driver from the filename extension.
414+
415+
### Keyword arguments
416+
417+
- `skip_keys` are passed as symbols, i.e., `skip_keys = (:a, :b)`
418+
- `driver=:all`, common options are `:netcdf` or `:zarr`.
419+
420+
Example:
421+
422+
````julia
423+
ds = open_dataset(f, driver=:zarr, skip_keys = (:c,))
424+
````
414425
"""
415426
function open_dataset(g; skip_keys=(), driver = :all)
416427
str_skipkeys = string.(skip_keys)

0 commit comments

Comments
 (0)