From 1ceabfc269f32a871d63e71b085f9a31a66fa082 Mon Sep 17 00:00:00 2001 From: Sebastian Spaeth Date: Fri, 19 Mar 2010 10:52:15 +0100 Subject: [PATCH] docs: Various typo fixes in docstrings --- cnotmuch/database.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/cnotmuch/database.py b/cnotmuch/database.py index 952bab41..f611777c 100644 --- a/cnotmuch/database.py +++ b/cnotmuch/database.py @@ -227,14 +227,16 @@ class Database(object): @property def db_p(self): - """Property returning a pointer to the notmuch_database_t or `None` + """Property returning a pointer to `notmuch_database_t` or `None` - This should normally not be needed by a user.""" + This should normally not be needed by a user (and is not yet + guaranteed to remain stable in future versions). + """ return self._db #------------------------------------------------------------------------------ class Query(object): - """ Represents a search query on an opened :class:`Database`. + """Represents a search query on an opened :class:`Database`. A query selects and filters a subset of messages from the notmuch database we derive from. @@ -276,7 +278,7 @@ class Query(object): self.create(db, querystr) def create(self, db, querystr): - """Creates a new query derived from a Database. + """Creates a new query derived from a Database This function is utilized by __init__() and usually does not need to be called directly.