[extractor/common] Document ie_key in url results
authorPhilipp Hagemeister <phihag@phihag.de>
Tue, 9 Dec 2014 09:58:06 +0000 (10:58 +0100)
committerPhilipp Hagemeister <phihag@phihag.de>
Tue, 9 Dec 2014 09:58:06 +0000 (10:58 +0100)
youtube_dl/extractor/common.py

index 2faaf6226600182abba37efc2eccd67be6e5ef03..cfd25cd212df5384ca249629f0621e0d960187f2 100644 (file)
@@ -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.