Revert "Convert docstrings to reStructuredText"
This reverts commit 3b1bd242d0.
This commit is contained in:
@@ -18,9 +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/>.
|
||||
|
||||
"""Reading .cue files.
|
||||
"""
|
||||
Reading .cue files
|
||||
|
||||
.. seealso:: http://digitalx.org/cuesheetsyntax.php
|
||||
See http://digitalx.org/cuesheetsyntax.php
|
||||
"""
|
||||
|
||||
import re
|
||||
@@ -58,25 +59,18 @@ _INDEX_RE = re.compile(r"""
|
||||
|
||||
|
||||
class CueFile(object):
|
||||
"""I represent a .cue file as an object.
|
||||
|
||||
:cvar logCategory:
|
||||
:vartype logCategory:
|
||||
:ivar path:
|
||||
:vartype path:
|
||||
:ivar rems:
|
||||
:vartype rems:
|
||||
:ivar messages:
|
||||
:vartype messages:
|
||||
:ivar leadout:
|
||||
:vartype leadout:
|
||||
:ivar table: the index table.
|
||||
:vartype table: L{table.Table}
|
||||
"""
|
||||
I represent a .cue file as an object.
|
||||
|
||||
@type table: L{table.Table}
|
||||
@ivar table: the index table.
|
||||
"""
|
||||
logCategory = 'CueFile'
|
||||
|
||||
def __init__(self, path):
|
||||
"""
|
||||
@type path: unicode
|
||||
"""
|
||||
assert type(path) is unicode, "%r is not unicode" % path
|
||||
|
||||
self._path = path
|
||||
@@ -157,12 +151,10 @@ class CueFile(object):
|
||||
continue
|
||||
|
||||
def message(self, number, message):
|
||||
"""Add a message about a given line in the cue file.
|
||||
"""
|
||||
Add a message about a given line in the cue file.
|
||||
|
||||
:param number: line number, counting from 0.
|
||||
:type number:
|
||||
:param message:
|
||||
:type message:
|
||||
@param number: line number, counting from 0.
|
||||
"""
|
||||
self._messages.append((number + 1, message))
|
||||
|
||||
@@ -187,24 +179,23 @@ class CueFile(object):
|
||||
return -1
|
||||
|
||||
def getRealPath(self, path):
|
||||
"""Translate the .cue's FILE to an existing path.
|
||||
"""
|
||||
Translate the .cue's FILE to an existing path.
|
||||
|
||||
:param path:
|
||||
:type path: unicode
|
||||
@type path: unicode
|
||||
"""
|
||||
return common.getRealPath(self._path, path)
|
||||
|
||||
|
||||
class File:
|
||||
"""I represent a FILE line in a cue file.
|
||||
|
||||
:ivar path:
|
||||
:vartype path:
|
||||
:ivar format:
|
||||
:vartype format:
|
||||
"""
|
||||
I represent a FILE line in a cue file.
|
||||
"""
|
||||
|
||||
def __init__(self, path, format):
|
||||
"""
|
||||
@type path: unicode
|
||||
"""
|
||||
assert type(path) is unicode, "%r is not unicode" % path
|
||||
|
||||
self.path = path
|
||||
|
||||
Reference in New Issue
Block a user