[vlc-commits] commit: python-vlc: improve docstrings (Jean Brouwers )

[git at videolan.org]

vlc/python | branch: master | Jean Brouwers <MrJean1 at Gmail.com> | Tue Nov 16 11:04:15 2010 +0100| [ef2df20269cca702ddcd496f472aa5bc9cffcdea] | committer: Olivier Aubert 

python-vlc: improve docstrings

Signed-off-by: Olivier Aubert <olivier.aubert at liris.cnrs.fr>

> http://git.videolan.org/gitweb.cgi/vlc/python.git/?a=commit;h=ef2df20269cca702ddcd496f472aa5bc9cffcdea
---

 override.py |    9 ++++++++-
 1 files changed, 8 insertions(+), 1 deletions(-)

diff --git a/override.py b/override.py
index 10a7fd9..9a62f04 100644
--- a/override.py
+++ b/override.py
@@ -73,6 +73,9 @@ class Instance:
         return l
 
 class Media:
+    """Create a new Media instance.
+    """
+
     def add_options(self, *list_of_options):
         """Add a list of options to the media.
 
@@ -153,7 +156,7 @@ class MediaPlayer:
         return track_description_list(libvlc_audio_get_track_description(self))
 
 class MediaListPlayer:
-    """Create a new MediaPlayer instance.
+    """Create a new MediaListPlayer instance.
 
     It may take as parameter either:
       - a vlc.Instance
@@ -183,6 +186,8 @@ class MediaListPlayer:
         return self._instance
 
 class LogIterator:
+    """Create a new VLC log iterator.
+    """
     def __iter__(self):
         return self
 
@@ -194,6 +199,8 @@ class LogIterator:
         return ret.contents
 
 class Log:
+    """Create a new VLC log instance.
+    """
     def __iter__(self):
         return self.get_iterator()