Fixup the description of the example python code

[notmuch-wiki] / howto.mdwn

diff --git a/howto.mdwn b/howto.mdwn
index 6db2a5b48e8fcfe45c269df8d84383ce37042a67..76405431282172106b605eb8d8f91a173dab9793 100644 (file)
--- a/howto.mdwn
+++ b/howto.mdwn
@@ -30,22 +30,21 @@ various "third party" notmuch utilities.
 
 * <span id="print_filenames">**Print only filenames of a search (python bindings)**</span>
 
 
 * <span id="print_filenames">**Print only filenames of a search (python bindings)**</span>
 

-  Notmuch includes [python bindings](http://pypi.python.org/pypi/notmuch)
-  to the notmuch shared library. Extensive API documentation
-  [is available](http://packages.python.org/notmuch).
+  Notmuch includes python bindings to the notmuch shared
+  library. Extensive API documentation [is
+  available](http://notmuchmail.readthedocs.org/).

 
   The bindings are very simple to use.  As an example, given you have
   the python bindings installed (or simply set your PYTHONPATH
   environment variable to point to the .../bindings/python directory),
 
   The bindings are very simple to use.  As an example, given you have
   the python bindings installed (or simply set your PYTHONPATH
   environment variable to point to the .../bindings/python directory),

-  this script will print the filenames of a matching search:
-
-                             #!/usr/bin/env python
-                             import sys
-                             import notmuch
-                             search = " ".join(sys.argv[1:])
-                             q = notmuch.Database().create_query(search)
-                             for m in q.search_messages():
-                                 print m.get_filename()
+  this snippet will produce a list of mails matching the given
+  expression:
+
+          >>> import notmuch
+          >>> db = notmuch.Database()
+          >>> query = db.create_query('tag:inbox AND NOT tag:killed')
+          >>> list(query.search_messages()) # doctest:+ELLIPSIS
+          [...]

 
 * <span id="sync_maildir_flags">**Sync notmuch tags and maildir flags**</span>
 
 
 * <span id="sync_maildir_flags">**Sync notmuch tags and maildir flags**</span>