From 7109903e6140e01b5d5980fc80c6ef1b6c86797a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sergey=20M=E2=80=A4?= <dstftw@gmail.com>
Date: Thu, 31 Dec 2015 03:10:44 +0600
Subject: [PATCH] [extractor/common] Document chapter and series fields
---
youtube_dl/extractor/common.py | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/youtube_dl/extractor/common.py b/youtube_dl/extractor/common.py
index 655207447..c443daf20 100644
--- a/youtube_dl/extractor/common.py
+++ b/youtube_dl/extractor/common.py
@@ -200,6 +200,26 @@ class InfoExtractor(object):
end_time: Time in seconds where the reproduction should end, as
specified in the URL.
+ The following fields should only be used when the video belongs to some logical
+ chapter or section:
+
+ chapter: Name or title of the chapter the video belongs to.
+ chapter_id: Number or id of the chapter the video belongs to, as an integer
+ or unicode string.
+
+ The following fields should only be used when the video is an episode of some
+ series or programme:
+
+ series: Title of the series or programme the video episode belongs to.
+ season: Title of the season the video episode belongs to.
+ season_id: Number or id of the season the video episode belongs to, as an
+ integer or unicode string.
+ episode: Title of the video episode. Unlike mandatory video title field,
+ this field should denote the exact title of the video episode
+ without any kind of decoration.
+ episode_id: Number or id of the video episode within a season, as an integer
+ or unicode string.
+
Unless mentioned otherwise, the fields should be Unicode strings.
Unless mentioned otherwise, None is equivalent to absence of information.