Skip to content

Commit

Permalink
Extended the close docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
gentlegiantJGC committed Nov 3, 2024
1 parent 29db7fa commit fb6f86f
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion src/leveldb/__init__leveldb.py.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -419,7 +419,11 @@ void init_leveldb(py::module m)
LevelDB.def(
"close",
&Amulet::LevelDB::close,
py::doc("Close the leveldb database."),
py::doc(
"Close the leveldb database.\n"
"Only the owner of the database may close it.\n"
"If needed, an external lock must be used to ensure that no other threads are accessing the database."
),
py::call_guard<py::gil_scoped_release>());

LevelDB.def(
Expand Down

0 comments on commit fb6f86f

Please sign in to comment.