[Xapian-tickets] [Xapian] #573: Python bindings should have a module doc string

Xapian nobody at xapian.org
Sat Oct 22 21:28:00 BST 2011


#573: Python bindings should have a module doc string
--------------------------------------+-------------------------------------
 Reporter:  james                     |       Owner:  richard
     Type:  enhancement               |      Status:  new    
 Priority:  normal                    |   Milestone:         
Component:  Xapian-bindings (Python)  |     Version:         
 Severity:  normal                    |   Blockedby:         
 Platform:  All                       |    Blocking:         
--------------------------------------+-------------------------------------
 At the moment `help(xapian)` uses a description extracted from the SWIG
 comment at the top of `xapian.py`; we should instead insert a doc string
 before it that is briefly helpful and points people to the online docs.
 (Ideally to a quickstart localised to python, once we have one.)

-- 
Ticket URL: <http://trac.xapian.org/ticket/573>
Xapian <http://xapian.org/>
Xapian



More information about the Xapian-tickets mailing list