From c09758213709816b7ac9e4758f3199a73a94fc46 Mon Sep 17 00:00:00 2001
From: Bezleputh <carton_ben@yahoo.fr>
Date: Tue, 18 Feb 2014 21:15:53 +0100
Subject: [PATCH] [senscritique] Add comments to explain magic code lines

---
 modules/senscritique/backend.py | 9 +++++++++
 modules/senscritique/browser.py | 5 +++--
 2 files changed, 12 insertions(+), 2 deletions(-)

diff --git a/modules/senscritique/backend.py b/modules/senscritique/backend.py
index 046a1c35..0f42856e 100644
--- a/modules/senscritique/backend.py
+++ b/modules/senscritique/backend.py
@@ -58,6 +58,10 @@ class SenscritiqueBackend(BaseBackend, ICapCalendarEvent):
         '16': u'Bouygues',
     }.iteritems())])
 
+    """
+    dict that represents ids list of general-interest channels included in a tv package
+    {'tv package id': ['general-interest channels ids list']}
+    """
     general = {
         9: [46, 2, 48, 56],
         1: [49, 46, 21, 2, 36, 59, 54, 48, 56, 50, 32, 1, 51, 24, 38, 34, 37, 6, 25, 11, 53, 26, 47],
@@ -69,6 +73,11 @@ class SenscritiqueBackend(BaseBackend, ICapCalendarEvent):
         16: [49, 46, 2, 36, 59, 54, 32, 24, 34, 37, 53, 47],
     }
 
+
+    """
+    dict that represents ids list of cinema channels included in a tv package
+    {'tv package id': ['cinema channels ids list']}
+    """
     cinema = {
         9: [10, 7],
         1: [10, 7, 9, 8, 52, 19, 18, 17, 16, 20, 15, 14, 4055, 44, 3, 45, 42, 41, 43, 13, 12],
diff --git a/modules/senscritique/browser.py b/modules/senscritique/browser.py
index 1cd416aa..ed771033 100644
--- a/modules/senscritique/browser.py
+++ b/modules/senscritique/browser.py
@@ -39,8 +39,9 @@ class SenscritiqueBrowser(BaseBrowser):
         '%s://%s/film/(.*?)' % (PROTOCOL, DOMAIN): EventPage,
     }
 
-    LIMIT = 25
-    LIMIT_NB_PAGES = 10
+    LIMIT = 25  # number of results returned for each ajax call (defined in the website).
+
+    LIMIT_NB_PAGES = 10 #  arbitrary limit to avoid infinitive loop that can occurs if total number of films is a multiple of LIMIT (in website it causes an infinite scroll)
 
     HEADER_AJAX = {"User-Agent": "Mozilla/5.0 (Windows; U; Windows "
                    "NT 5.1; en-US; rv:1.9.2.8) Gecko/20100722 Firefox/3.6.8"