aboutsummaryrefslogtreecommitdiffhomepage
path: root/bindings/python/docs
diff options
context:
space:
mode:
authorGravatar Justus Winter <4winter@informatik.uni-hamburg.de>2012-04-30 19:48:45 +0200
committerGravatar Justus Winter <4winter@informatik.uni-hamburg.de>2012-04-30 19:48:45 +0200
commitca1e232e5fa35c2fabe0ef4fcb78911bcffe67b8 (patch)
tree12d907542b96111f8d0e2bd1503d33622b21595b /bindings/python/docs
parente9bcbe7e70d0811f11e58466735b2bf7c8f0a3fc (diff)
python: document the Database.close function
Put a prominent warning into the docstring of Database.close, make the function show up in the sphinx doc and refer to the warning in the paragraph mentioning the context manager protocol. Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
Diffstat (limited to 'bindings/python/docs')
-rw-r--r--bindings/python/docs/source/database.rst2
1 files changed, 2 insertions, 0 deletions
diff --git a/bindings/python/docs/source/database.rst b/bindings/python/docs/source/database.rst
index ee71085f..2464bfff 100644
--- a/bindings/python/docs/source/database.rst
+++ b/bindings/python/docs/source/database.rst
@@ -9,6 +9,8 @@
.. automethod:: open(path, status=MODE.READ_ONLY)
+ .. automethod:: close
+
.. automethod:: get_path
.. automethod:: get_version