Docs: jobs methods work with finished jobs by default

Author: vshlapakov

scrapinghub/client/jobs.py

@@ -60,6 +60,9 @@ def count(self, spider=None, state=None, has_tag=None, lacks_tag=None,
         :return: jobs count.
         :rtype: :class:`int`
 
+        The endpoint used by the method counts only finished jobs by default,
+        use ``state`` parameter to count jobs in other states.
+
         Usage::
 
             >>> spider = project.spiders.get('spider1')
@@ -99,6 +102,9 @@ def iter(self, count=None, start=None, spider=None, state=None,
             for a given filter params.
         :rtype: :class:`types.GeneratorType[dict]`
 
+        The endpoint used by the method returns only finished jobs by default,
+        use ``state`` parameter to return jobs in other states.
+
         Usage:
 
         - retrieve all jobs for a spider::
@@ -166,6 +172,9 @@ def list(self, count=None, start=None, spider=None, state=None,
         :return: list of dictionaries of jobs summary for a given filter params.
         :rtype: :class:`list[dict]`
 
+        The endpoint used by the method returns only finished jobs by default,
+        use ``state`` parameter to return jobs in other states.
+
         Please note that :meth:`list` can use a lot of memory and for a large
         amount of logs it's recommended to iterate through it via :meth:`iter`
         method (all params and available filters are same for both methods).