[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#607031: python-apt: Documentation for apt.package.BaseDependency.relation is incorrect



Package: python-apt
Version: 0.7.96.1ubuntu11
Severity: normal
Tags: upstream patch

It's very simple (although it ended up wasting an afternoon to find the
problem).  The documentation for apt.package.BaseDependency.relation as seen at 

http://apt.alioth.debian.org/python-apt-doc/library/apt.package.html#apt.package.BaseDependency

implies it takes values from the set (>>,>=,==,<<,<=,), where as in fact it
takes values from the set (>,>=,==,<,<=,) (the class docstring gets it right).

The super simple fix is in the attached patch, or on Launchpad in
lp:~mwhudson/python-apt/BaseDependency-doc-fix

Cheers,
mwh


-- System Information:
Debian Release: squeeze/sid
  APT prefers maverick-updates
  APT policy: (500, 'maverick-updates'), (500, 'maverick-security'), (500, 'maverick')
Architecture: amd64 (x86_64)

Kernel: Linux 2.6.35-23-generic (SMP w/2 CPU cores)
Locale: LANG=en_NZ.UTF-8, LC_CTYPE=en_NZ.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash

Versions of packages python-apt depends on:
ii  apt [libapt-pkg4.10]    0.8.3ubuntu7     Advanced front-end for dpkg
ii  apt-utils [libapt-inst1 0.8.3ubuntu7     APT utility programs
ii  libc6                   2.12.1-0ubuntu9  Embedded GNU C Library: Shared lib
ii  libgcc1                 1:4.5.1-7ubuntu2 GCC support library
ii  libstdc++6              4.5.1-7ubuntu2   The GNU Standard C++ Library v3
ii  python                  2.6.6-2ubuntu1   interactive high-level object-orie
ii  python-central          0.6.15ubuntu2    register and build utility for Pyt

Versions of packages python-apt recommends:
ii  iso-codes                 3.17-1         ISO language, territory, currency,
ii  lsb-release               4.0-0ubuntu8   Linux Standard Base version report
ii  python2.6                 2.6.6-5ubuntu1 An interactive high-level object-o

Versions of packages python-apt suggests:
pn  python-apt-dbg         <none>            (no description available)
pn  python-apt-doc         <none>            (no description available)
ii  python-gtk2            2.21.0-0ubuntu1   Python bindings for the GTK+ widge
ii  python-vte             1:0.26.0-0ubuntu2 Python bindings for the VTE widget

-- no debconf information
=== modified file 'doc/source/library/apt.package.rst'
--- doc/source/library/apt.package.rst	2009-07-23 19:42:17 +0000
+++ doc/source/library/apt.package.rst	2010-12-14 04:36:31 +0000
@@ -34,7 +34,7 @@
 
     .. attribute:: relation
 
-        The relation (>>,>=,==,<<,<=,)
+        The relation (>,>=,==,<,<=,)
 
     .. attribute:: version
 


Reply to: