summaryrefslogtreecommitdiff
path: root/python/cdrom.cc
diff options
context:
space:
mode:
authorJulian Andres Klode <jak@debian.org>2010-04-21 16:59:48 +0200
committerJulian Andres Klode <jak@debian.org>2010-04-21 16:59:48 +0200
commit6a519d479e384b0c1044ee456b1b0fb90ab41248 (patch)
treea8396c55a775a2419066d4bf63ad29349371dd56 /python/cdrom.cc
parentd624e84bf5ea40d2ae19b8ac02af77766e063d52 (diff)
downloadpython-apt-6a519d479e384b0c1044ee456b1b0fb90ab41248.tar.gz
python: Commit documentation changes suggested by debian-l10n-english.
Diffstat (limited to 'python/cdrom.cc')
-rw-r--r--python/cdrom.cc9
1 files changed, 6 insertions, 3 deletions
diff --git a/python/cdrom.cc b/python/cdrom.cc
index 022a4b00..7f89e9d3 100644
--- a/python/cdrom.cc
+++ b/python/cdrom.cc
@@ -30,7 +30,7 @@
static char *cdrom_add_doc =
"add(progress: apt_pkg.CdromProgress) -> bool\n\n"
- "Add the given CD-ROM to the sources.list. Returns True on success, may\n"
+ "Add the given CD-ROM to the sources.list. Return True on success;\n"
"raise an error on failure or return False.";
static PyObject *cdrom_add(PyObject *Self,PyObject *Args)
{
@@ -51,8 +51,11 @@ static PyObject *cdrom_add(PyObject *Self,PyObject *Args)
static char *cdrom_ident_doc =
"ident(progress: apt_pkg.CdromProgress) -> str\n\n"
- "Try to identify the CD-ROM and if successful return the identity as a\n"
- "string. Otherwise, return None or raise an error.";
+ "Try to identify the CD-ROM and if successful return the hexadecimal\n"
+ "CDROM-ID (and a integer version suffix seperated by -) as a\n"
+ "string. Otherwise, return None or raise an error.\n\n"
+ "The ID is created by hashing all file and directory names on the\n"
+ "CD-ROM and appending the version.";
static PyObject *cdrom_ident(PyObject *Self,PyObject *Args)
{
pkgCdrom &Cdrom = GetCpp<pkgCdrom>(Self);