youtube-dl

commit f58766ce5cc5a1c6d651560591bad119787e94b2
parent 15644a40df9881162bfdeec6e4f6b798894f0e47
Author: Philipp Hagemeister <phihag@phihag.de>
Date:   Tue,  9 Dec 2014 10:58:06 +0100

[extractor/common] Document ie_key in url results

Diffstat:
M
youtube_dl/extractor/common.py
 | 
7
++++---

1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/youtube_dl/extractor/common.py b/youtube_dl/extractor/common.py
@@ -174,9 +174,10 @@ class InfoExtractor(object):
     _type "url" indicates that the video must be extracted from another
     location, possibly by a different extractor. Its only required key is:
     "url" - the next URL to extract.
-
-    Additionally, it may have properties believed to be identical to the
-    resolved entity, for example "title" if the title of the referred video is
+    The key "ie_key" can be set to the class name (minus the trailing "IE",
+    e.g. "Youtube") if the extractor class is known in advance.
+    Additionally, the dictionary may have any properties of the resolved entity
+    known in advance, for example "title" if the title of the referred video is
     known ahead of time.