From bd083e7d43220eb37cffe240fdee8f1e3a0416ca Mon Sep 17 00:00:00 2001 From: Christophe Benz Date: Thu, 25 Nov 2010 19:14:10 +0100 Subject: [PATCH] add docstrings --- weboob/capabilities/video.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/weboob/capabilities/video.py b/weboob/capabilities/video.py index 0247c3e2..b7480c05 100644 --- a/weboob/capabilities/video.py +++ b/weboob/capabilities/video.py @@ -41,6 +41,10 @@ class VideoThumbnail(CapBaseObject): class BaseVideo(CapBaseObject): + """ + Represents a video. + This object has to be inherited to specify how to calculate the URL of the video from its ID. + """ def __init__(self, _id, title=NotLoaded, url=NotLoaded, author=NotLoaded, duration=NotLoaded, date=NotLoaded, rating=NotLoaded, rating_max=NotLoaded, thumbnail=NotLoaded, thumbnail_url=None, nsfw=False): CapBaseObject.__init__(self, unicode(_id)) @@ -71,6 +75,9 @@ class BaseVideo(CapBaseObject): class ICapVideo(IBaseCap): + """ + This capability represents the ability for a website backend to provide videos. + """ (SEARCH_RELEVANCE, SEARCH_RATING, SEARCH_VIEWS,