Fix Python examples in documentation

Author: chekunkov

docs/client/overview.rst

@@ -145,8 +145,8 @@ Scheduling logic supports different options, like
 
 For example, to run a new job for a given spider with custom params::
 
-    >>> job = spider.jobs.run(units=2, job_settings={'SETTING': 'VALUE'},
-        priority=1, add_tag=['tagA','tagB'], meta={'custom-data': 'val1'})
+    >>> job = spider.jobs.run(units=2, job_settings={'SETTING': 'VALUE'}, priority=1,
+    ...                       add_tag=['tagA','tagB'], meta={'custom-data': 'val1'})
 
 Note that if you run a job on project level, spider name is required::
 
@@ -192,7 +192,7 @@ ones::
     >>> job_summary = next(project.jobs.iter())
     >>> job_summary.get('spider', 'missing')
     'foo'
-    >>> jobs_summary = project.jobs.iter(jobmeta=['scheduled_by', ])
+    >>> jobs_summary = project.jobs.iter(jobmeta=['scheduled_by'])
     >>> job_summary = next(jobs_summary)
     >>> job_summary.get('scheduled_by', 'missing')
     'John'
@@ -227,10 +227,10 @@ for filtering by state:
 - finished
 - deleted
 
-Dict entries returned by ``iter`` method contain some additional meta,
+Dictionary entries returned by ``iter`` method contain some additional meta,
 but can be easily converted to :class:`~scrapinghub.client.jobs.Job` instances with::
 
-    >>> [Job(x['key']) for x in jobs]
+    >>> [Job(client, x['key']) for x in jobs]
     [
       <scrapinghub.client.Job at 0x106e2cc18>,
       <scrapinghub.client.Job at 0x106e260b8>,
@@ -422,9 +422,9 @@ To post a new activity event::
 Or post multiple events at once::
 
     >>> events = [
-        {'event': 'job:completed', 'job': '123/2/5', 'user': 'john'},
-        {'event': 'job:cancelled', 'job': '123/2/6', 'user': 'john'},
-    ]
+    ...     {'event': 'job:completed', 'job': '123/2/5', 'user': 'john'},
+    ...     {'event': 'job:cancelled', 'job': '123/2/6', 'user': 'john'},
+    ... ]
     >>> project.activity.add(events)
 
 

docs/legacy/hubstorage.rst

@@ -130,7 +130,7 @@ If it used, then it's up to the user to list all the required fields, so only fe
     >>> metadata = next(project.jobq.list())
     >>> metadata.get('spider', 'missing')
     u'foo'
-    >>> jobs_metadata = project.jobq.list(jobmeta=['scheduled_by', ])
+    >>> jobs_metadata = project.jobq.list(jobmeta=['scheduled_by'])
     >>> metadata = next(jobs_metadata)
     >>> metadata.get('scheduled_by', 'missing')
     u'John'
@@ -150,7 +150,7 @@ List of tags has ``OR`` power, so in the case above jobs with 'new' or 'verified
 
 To get certain number of last finished jobs per some spider::
 
-    >>> jobs_metadata = project.jobq.list(spider='foo', state='finished' count=3)
+    >>> jobs_metadata = project.jobq.list(spider='foo', state='finished', count=3)
 
 There are 4 possible job states, which can be used as values for filtering by state:
 
@@ -167,7 +167,7 @@ To iterate through items::
 
     >>> items = job.items.iter_values()
     >>> for item in items:
-    # do something, item is just a dict
+    ...     # do something, item is just a dict
 
 Logs
 ^^^^
@@ -176,7 +176,7 @@ To iterate through 10 first logs for example::
 
     >>> logs = job.logs.iter_values(count=10)
     >>> for log in logs:
-    # do something, log is a dict with log level, message and time keys
+    ...     # do something, log is a dict with log level, message and time keys
 
 Collections
 ^^^^^^^^^^^
@@ -246,4 +246,4 @@ Module contents
     :undoc-members:
     :show-inheritance:
 
-.. _scrapinghub.ScrapinghubClient: ../client/overview.html 
+.. _scrapinghub.ScrapinghubClient: ../client/overview.html

docs/quickstart.rst

@@ -36,7 +36,7 @@ Work with your projects::
 Run new jobs from the client::
 
     >>> project = client.get_project(123)
-    >>> project.jobs.run('spider1', job_args={'arg1':'val1'})
+    >>> project.jobs.run('spider1', job_args={'arg1': 'val1'})
     <scrapinghub.client.Job at 0x106ee12e8>>
 
 Access your jobs data::

scrapinghub/client/activity.py

@@ -31,16 +31,16 @@ class Activity(_Proxy):
     - post a new event::
 
         >>> event = {'event': 'job:completed',
-                     'job': '123/2/4',
-                     'user': 'jobrunner'}
+        ...          'job': '123/2/4',
+        ...          'user': 'jobrunner'}
         >>> project.activity.add(event)
 
     - post multiple events at once::
 
         >>> events = [
-            {'event': 'job:completed', 'job': '123/2/5', 'user': 'jobrunner'},
-            {'event': 'job:cancelled', 'job': '123/2/6', 'user': 'john'},
-        ]
+        ...    {'event': 'job:completed', 'job': '123/2/5', 'user': 'jobrunner'},
+        ...    {'event': 'job:cancelled', 'job': '123/2/6', 'user': 'john'},
+        ... ]
         >>> project.activity.add(events)
 
     """

scrapinghub/client/collections.py

@@ -108,7 +108,7 @@ class Collection(object):
     - add a new item to collection::
 
         >>> foo_store.set({'_key': '002d050ee3ff6192dcbecc4e4b4457d7',
-                           'value': '1447221694537'})
+        ...                'value': '1447221694537'})
 
     - count items in collection::
 
@@ -128,7 +128,7 @@ class Collection(object):
     - iterate iterate over _key & value pair::
 
         >>> for elem in foo_store.iter(count=1)):
-        >>> ... print(elem)
+        ...     print(elem)
         [{'_key': '002d050ee3ff6192dcbecc4e4b4457d7', 'value': '1447221694537'}]
 
     - filter by multiple keys, only values for keys that exist will be returned::

scrapinghub/client/items.py

@@ -25,7 +25,7 @@ class Items(_ItemsResourceProxy, _DownloadableProxyMixin):
     - iterate through first 100 items and print them::
 
         >>> for log in job.logs.iter(count=100):
-        >>> ... print(log)
+        ...     print(log)
 
     - retrieve items with timestamp greater or equal to given timestamp
       (item here is an arbitrary dictionary depending on your code)::

scrapinghub/client/jobs.py

@@ -540,7 +540,7 @@ class JobMeta(_MappingProxy):
 
     - update multiple meta fields at once
 
-        >>> job.metadata.update({'my-meta1': 'test1', 'my-meta2': 'test2})
+        >>> job.metadata.update({'my-meta1': 'test1', 'my-meta2': 'test2'})
 
     - delete meta field by name::
 

scrapinghub/client/logs.py

@@ -28,7 +28,7 @@ class Logs(_ItemsResourceProxy, _DownloadableProxyMixin):
     - iterate through first 100 log entries and print them::
 
         >>> for log in job.logs.iter(count=100):
-        >>> ... print(log)
+        ...     print(log)
 
     - retrieve a single log entry from a job::