Skip to content

Commit e75fd4d

Browse files
committed
Add spider_args param to the docs
1 parent 50222c4 commit e75fd4d

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Jobs instance is described well in ``Jobs`` section below.
8888

8989
For example, to schedule a spider run (it returns a job object)::
9090

91-
>>> project.jobs.schedule('spider1', arg1='val1')
91+
>>> project.jobs.schedule('spider1', spider_args={'arg1':'val1'})
9292
<scrapinghub.client.Job at 0x106ee12e8>>
9393

9494
Project instance also has the following fields:
@@ -128,7 +128,7 @@ Like project instance, spider instance has ``jobs`` field to work with the spide
128128

129129
To schedule a spider run::
130130

131-
>>> spider.jobs.schedule(arg1='val1')
131+
>>> spider.jobs.schedule(spider_args={'arg1:'val1'})
132132
<scrapinghub.client.Job at 0x106ee12e8>>
133133

134134
Note that you don't need to specify spider name explicitly.
@@ -160,6 +160,7 @@ Use ``schedule`` method to schedule a new job for project/spider::
160160

161161
Scheduling logic supports different options, like
162162

163+
- spider_args to provide spider arguments for the job
163164
- units to specify amount of units to schedule the job
164165
- job_settings to pass additional settings for the job
165166
- priority to set higher/lower priority of the job

0 commit comments

Comments
 (0)