Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
thorbjoernl committed Jul 26, 2024
1 parent 1337292 commit 4cfe462
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/aerovaldb/plugins.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,9 @@ def open(resource, /, use_async: bool = False) -> AerovalDB:
:param resource: the resource-name for the database. The resource can be
- 'entrypoint:path', with path being the location where the database should be generated
- 'path', with path containing either an aerovaldb.cfg configuration
- or path being a json_files dabasase
(eg. 'json_files:.')
- 'path', with path containing either an aerovaldb.cfg (Not yet implemented) configuration
or path being a json_files dabasase (for example, '.' is equivalent to 'json_files:.')
:param use_async : If true, aiofile will be used to read files, otherwise files will be read
synchronously.
:return: an implementation-object of AerovalDB openend to a location
Expand Down

0 comments on commit 4cfe462

Please sign in to comment.