python/apt_pkgmodule.cc: Fix documentation of version_compare (Closes: #680891)

This was supposed to be fixed some time ago in mvo's bzr branch but it seems
that it did not survive the git migration.

2 files changed, 5 insertions, 2 deletions

diff --git a/debian/changelog b/debian/changelog
index e1bcc2ae..06a8ca4f 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -10,6 +10,8 @@ python-apt (0.9.0) UNRELEASED; urgency=low
   * Completely remove all old-API support code
   * aptsources/sourceslist.py
     - Document correct use of uniq and hide it using __all__ (Closes: #723815)
+  * python/apt_pkgmodule.cc:
+    - Fix documentation of version_compare (Closes: #680891)
 
   [ Jeremy Bicha ]
   * data/templates/Ubuntu.info.in: add 'devel' series (Closes: #722961)
diff --git a/python/apt_pkgmodule.cc b/python/apt_pkgmodule.cc
index 5b06f721..65a7c950 100644
--- a/python/apt_pkgmodule.cc
+++ b/python/apt_pkgmodule.cc
@@ -59,8 +59,9 @@ static PyObject *py_gettext(PyObject *self, PyObject *Args) {
 // These are kind of legacy..
 static char *doc_VersionCompare =
     "version_compare(a: str, b: str) -> int\n\n"
-    "Compare the given versions; return -1 if 'a' is smaller than 'b',\n"
-    "0 if they are equal, and 2 if 'a' is larger than 'b'.";
+    "Compare the given versions; return a strictly negative value if 'a' is \n"
+    "smaller than 'b', 0 if they are equal, and a strictly positive value if\n"
+    "'a' is larger than 'b'.";
 static PyObject *VersionCompare(PyObject *Self,PyObject *Args)
 {
    char *A;