From: yomguy <yomguy@parisson.com>
Date: Wed, 25 Nov 2009 21:34:04 +0000 (+0000)
Subject: cleanup descriptions
X-Git-Tag: 0.3.2~231
X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=1cc82c097b46c684e82360fbba2d33888ee233e9;p=timeside.git

cleanup descriptions
---

diff --git a/analyze/api.py b/analyze/api.py
index 6584d31..b02bf4b 100644
--- a/analyze/api.py
+++ b/analyze/api.py
@@ -26,9 +26,9 @@ class IAnalyzer(Interface):
 
     def id():
         """Return a short id alphanumeric, lower-case string."""
-
+s
     def name():
-        """Return the analyze name, such as "Mean Level", "Max level",
+        """Return the analyzer name, such as "Mean Level", "Max level",
         "Total length, etc..
         """
 
diff --git a/encode/api.py b/encode/api.py
index 7f77f75..4e45324 100644
--- a/encode/api.py
+++ b/encode/api.py
@@ -46,6 +46,14 @@ class IEncoder(Interface):
     def mime_type():
         """Return the mime type corresponding to this encode format"""
 
+    def set_cache_dir(path):
+        """Set the directory where cached files should be stored. Does nothing
+        if the encoder doesn't support caching.
+       
+        The driver shouldn't assume that this method will always get called. A
+        temporary directory should be used if that's not the case.
+        """
+        
     def process(source, metadata, options=None):
         """Perform the encoding process and stream the result as a generator.
 
diff --git a/encode/flac.py b/encode/flac.py
index 8c38ac2..8312e90 100644
--- a/encode/flac.py
+++ b/encode/flac.py
@@ -50,10 +50,7 @@ class FlacEncoder(EncoderCore):
     def description(self):
         return """
         Free Lossless Audio Codec (FLAC) is a file format for lossless audio
-        data compression. During compression, FLAC does not lose quality from
-        the audio stream, as lossy compression formats such as MP3, AAC, and
-        Vorbis do. Josh Coalson is the primary author of FLAC.
-        (source Wikipedia)
+        data compression.
         """
 
     def get_file_info(self):
diff --git a/encode/mp3.py b/encode/mp3.py
index 4f04ab5..e38f5b8 100644
--- a/encode/mp3.py
+++ b/encode/mp3.py
@@ -64,11 +64,6 @@ class Mp3Encoder(EncoderCore):
         return """
         MPEG-1 Audio Layer 3, more commonly referred to as MP3, is a patented
         digital audio encoding format using a form of lossy data compression.
-        It is a common audio format for consumer audio storage, as well as a
-        de facto standard of digital audio compression for the transfer and
-        playback of music on digital audio players. MP3 is an audio-specific
-        format that was designed by the Moving Picture Experts Group as part
-        of its MPEG-1 standard. (source Wikipedia)
         """
 
     def get_file_info(self):