From 90a8a8b981c1709783db1b9457040ab09d76187b Mon Sep 17 00:00:00 2001
From: Amir Mohammadi <183.amir@gmail.com>
Date: Thu, 20 Apr 2017 10:18:11 +0200
Subject: [PATCH] mention the operator usage in documentation too
---
bob/io/base/hdf5.cpp | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/bob/io/base/hdf5.cpp b/bob/io/base/hdf5.cpp
index d909e54..ad8a823 100644
--- a/bob/io/base/hdf5.cpp
+++ b/bob/io/base/hdf5.cpp
@@ -301,7 +301,8 @@ static auto s_has_dataset = bob::extension::FunctionDoc(
"Checks if a dataset exists inside a file",
"Checks if a dataset exists inside a file, on the specified path. "
"If the given path is relative, it is take w.r.t. to the current working directory.\n\n"
- ".. note:: The functions :py:meth:`has_dataset` and :py:meth:`has_key` are synonyms.",
+ ".. note:: The functions :py:meth:`has_dataset` and :py:meth:`has_key` are synonyms. "
+ "You can also use the Python's ``in`` operator instead of :py:meth:`has_key`: ``key in hdf5file``.",
true
)
.add_prototype("key")
--
GitLab