Opened 13 years ago

Closed 13 years ago

#573 closed enhancement (fixed)

Python bindings should have a module doc string

Reported by: James Aylett Owned by: Olly Betts
Priority: normal Milestone: 1.2.8
Component: Xapian-bindings (Python) Version:
Severity: normal Keywords:
Cc: Blocked By:
Blocking: Operating System: All

Description

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.)

Attachments (1)

pydoc.diff​ (2.0 KB ) - added by James Aylett 13 years ago.
Untested patch (build system is hosed on my netbook)

Download all attachments as: .zip

Change History (3)

by James Aylett, 13 years ago

Attachment: pydoc.diff​ added

Untested patch (build system is hosed on my netbook)

comment:1 by Olly Betts, 13 years ago

Milestone: → 1.2.8
Owner: changed from Richard Boulton to Olly Betts
Status: new → assigned

Applied patch, tweaked a little, tested, and committed as r16089.

Marking to backport for 1.2.8.

comment:2 by Olly Betts, 13 years ago

Resolution: → fixed
Status: assigned → closed

Backported to branches/1.2 in r16146.

Note: See TracTickets for help on using tickets.