Revert "Convert docstrings to reStructuredText"
This reverts commit 3b1bd242d0.
This commit is contained in:
@@ -18,6 +18,10 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with whipper. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
"""
|
||||
Wrap on-disk CD images based on the .cue file.
|
||||
"""
|
||||
|
||||
import os
|
||||
|
||||
from whipper.common import encode
|
||||
@@ -31,23 +35,17 @@ logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class Image(object):
|
||||
"""Wrap on-disk CD images based on the .cue file.
|
||||
|
||||
:ivar path: .cue path.
|
||||
:vartype path: unicode
|
||||
:ivar cue:
|
||||
:vartype cue:
|
||||
:ivar offsets:
|
||||
:vartype offsets:
|
||||
:ivar lengths:
|
||||
:vartype lengths:
|
||||
:ivar table: the Table of Contents for this image.
|
||||
:vartype table: L{table.Table}
|
||||
"""
|
||||
|
||||
@ivar table: The Table of Contents for this image.
|
||||
@type table: L{table.Table}
|
||||
"""
|
||||
logCategory = 'Image'
|
||||
|
||||
def __init__(self, path):
|
||||
"""
|
||||
@type path: unicode
|
||||
@param path: .cue path
|
||||
"""
|
||||
assert type(path) is unicode, "%r is not unicode" % path
|
||||
|
||||
self._path = path
|
||||
@@ -59,22 +57,19 @@ class Image(object):
|
||||
self.table = None
|
||||
|
||||
def getRealPath(self, path):
|
||||
"""Translate the .cue's FILE to an existing path.
|
||||
"""
|
||||
Translate the .cue's FILE to an existing path.
|
||||
|
||||
:param path: .cue path.
|
||||
:type path:
|
||||
@param path: .cue path
|
||||
"""
|
||||
assert type(path) is unicode, "%r is not unicode" % path
|
||||
|
||||
return self.cue.getRealPath(path)
|
||||
|
||||
def setup(self, runner):
|
||||
"""Do initial setup.
|
||||
|
||||
Like figuring out track lengths and constructing the Table of Contents.
|
||||
|
||||
:param runner:
|
||||
:type runner:
|
||||
"""
|
||||
Do initial setup, like figuring out track lengths, and
|
||||
constructing the Table of Contents.
|
||||
"""
|
||||
logger.debug('setup image start')
|
||||
verify = ImageVerifyTask(self)
|
||||
@@ -113,18 +108,8 @@ class Image(object):
|
||||
|
||||
|
||||
class ImageVerifyTask(task.MultiSeparateTask):
|
||||
"""I verify a disk image and get the necessary track lengths.
|
||||
|
||||
:cvar logCategory:
|
||||
:vartype logCategory:
|
||||
:cvar description:
|
||||
:vartype description:
|
||||
:cvar lengths:
|
||||
:vartype lengths:
|
||||
:ivar image:
|
||||
:vartype image:
|
||||
:ivar tasks:
|
||||
:vartype tasks:
|
||||
"""
|
||||
I verify a disk image and get the necessary track lengths.
|
||||
"""
|
||||
|
||||
logCategory = 'ImageVerifyTask'
|
||||
@@ -188,14 +173,8 @@ class ImageVerifyTask(task.MultiSeparateTask):
|
||||
|
||||
|
||||
class ImageEncodeTask(task.MultiSeparateTask):
|
||||
"""I encode a disk image to a different format.
|
||||
|
||||
:ivar image:
|
||||
:vartype image:
|
||||
:ivar tasks:
|
||||
:vartype tasks:
|
||||
:ivar lengths:
|
||||
:vartype lengths:
|
||||
"""
|
||||
I encode a disk image to a different format.
|
||||
"""
|
||||
|
||||
description = "Encoding tracks"
|
||||
|
||||
Reference in New Issue
Block a user