Skip to content

Commit c56ab2d

Browse files
committed
:param \*\*foo: → :param foo:
1 parent 07c28dc commit c56ab2d

File tree

5 files changed

+19
-19
lines changed

5 files changed

+19
-19
lines changed

scrapinghub/client/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ class ScrapinghubClient(object):
3838
If you need full access to *Scrapy Cloud* features, you'll need to
3939
provide a Scrapinghub APIKEY through this argument or deploying ``SH_APIKEY``.
4040
:param dash_endpoint: (optional) Scrapinghub Dash panel url.
41-
:param \*\*kwargs: (optional) Additional arguments for
41+
:param kwargs: (optional) Additional arguments for
4242
:class:`~scrapinghub.hubstorage.HubstorageClient` constructor.
4343
4444
:ivar projects: projects collection,

scrapinghub/client/collections.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ def get(self, key, **params):
160160
"""Get item from collection by key.
161161
162162
:param key: string item key.
163-
:param \*\*params: (optional) additional query params for the request.
163+
:param params: (optional) additional query params for the request.
164164
:return: an item dictionary if exists.
165165
:rtype: :class:`dict`
166166
"""
@@ -217,7 +217,7 @@ def iter(self, key=None, prefix=None, prefixcount=None, startts=None,
217217
:param startts: UNIX timestamp at which to begin results.
218218
:param endts: UNIX timestamp at which to end results.
219219
:param requests_params: (optional) a dict with optional requests params.
220-
:param \*\*params: (optional) additional query params for the request.
220+
:param params: (optional) additional query params for the request.
221221
:return: an iterator over items list.
222222
:rtype: :class:`collections.abc.Iterable[dict]`
223223
"""
@@ -243,7 +243,7 @@ def list(self, key=None, prefix=None, prefixcount=None, startts=None,
243243
:param startts: UNIX timestamp at which to begin results.
244244
:param endts: UNIX timestamp at which to end results.
245245
:param requests_params: (optional) a dict with optional requests params.
246-
:param \*\*params: (optional) additional query params for the request.
246+
:param params: (optional) additional query params for the request.
247247
:return: a list of items where each item is represented with a dict.
248248
:rtype: :class:`list[dict]`
249249
"""

scrapinghub/client/frontiers.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ def add(self, fps):
319319
def iter(self, **params):
320320
"""Iterate through fingerprints in the slot.
321321
322-
:param \*\*params: (optional) additional query params for the request.
322+
:param params: (optional) additional query params for the request.
323323
:return: an iterator over fingerprints.
324324
:rtype: :class:`collections.abc.Iterable[str]`
325325
"""
@@ -331,7 +331,7 @@ def iter(self, **params):
331331
def list(self, **params):
332332
"""List fingerprints in the slot.
333333
334-
:param \*\*params: (optional) additional query params for the request.
334+
:param params: (optional) additional query params for the request.
335335
:return: a list of fingerprints.
336336
:rtype: :class:`list[str]`
337337
"""
@@ -355,7 +355,7 @@ def iter(self, mincount=None, **params):
355355
"""Iterate through batches in the queue.
356356
357357
:param mincount: (optional) limit results with min amount of requests.
358-
:param \*\*params: (optional) additional query params for the request.
358+
:param params: (optional) additional query params for the request.
359359
:return: an iterator over request batches in the queue where each
360360
batch is represented with a dict with ('id', 'requests') field.
361361
:rtype: :class:`collections.abc.Iterable[dict]`
@@ -369,7 +369,7 @@ def list(self, mincount=None, **params):
369369
"""List request batches in the queue.
370370
371371
:param mincount: (optional) limit results with min amount of requests.
372-
:param \*\*params: (optional) additional query params for the request.
372+
:param params: (optional) additional query params for the request.
373373
:return: a list of request batches in the queue where each batch
374374
is represented with a dict with ('id', 'requests') field.
375375
:rtype: :class:`list[dict]`

scrapinghub/client/jobs.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ def count(self, spider=None, state=None, has_tag=None, lacks_tag=None,
5757
in milliseconds.
5858
:param endts: (optional) UNIX timestamp at which to end results,
5959
in milliseconds.
60-
:param \*\*params: (optional) other filter params.
60+
:param params: (optional) other filter params.
6161
6262
:return: jobs count.
6363
:rtype: :class:`int`
@@ -156,7 +156,7 @@ def iter(self, count=None, start=None, spider=None, state=None,
156156
in millisecons.
157157
:param meta: (optional) request for additional fields, a single
158158
field name or a list of field names to return.
159-
:param \*\*params: (optional) other filter params.
159+
:param params: (optional) other filter params.
160160
161161
:return: a generator object over a list of dictionaries of jobs summary
162162
for a given filter params.
@@ -227,7 +227,7 @@ def list(self, count=None, start=None, spider=None, state=None,
227227
in milliseconds.
228228
:param meta: (optional) request for additional fields, a single
229229
field name or a list of field names to return.
230-
:param \*\*params: (optional) other filter params.
230+
:param params: (optional) other filter params.
231231
232232
:return: list of dictionaries of jobs summary for a given filter params.
233233
:rtype: :class:`list[dict]`
@@ -262,7 +262,7 @@ def run(self, spider=None, units=None, priority=None, meta=None,
262262
:param job_settings: (optional) a dictionary with job settings.
263263
:param cmd_args: (optional) a string with script command args.
264264
:param environment: (option) a dictionary with custom environment
265-
:param \*\*params: (optional) additional keyword args.
265+
:param params: (optional) additional keyword args.
266266
267267
:return: a job instance, representing the scheduled job.
268268
:rtype: :class:`Job`
@@ -334,7 +334,7 @@ def summary(self, state=None, spider=None, **params):
334334
:param state: (optional) a string state to filter jobs.
335335
:param spider: (optional) a spider name (not needed if instantiated
336336
with :class:`~scrapinghub.client.spiders.Spider`).
337-
:param \*\*params: (optional) additional keyword args.
337+
:param params: (optional) additional keyword args.
338338
:return: a list of dictionaries of jobs summary
339339
for a given filter params grouped by job state.
340340
:rtype: :class:`list[dict]`
@@ -362,7 +362,7 @@ def iter_last(self, start=None, start_after=None, count=None,
362362
:param count: (optional)
363363
:param spider: (optional) a spider name (not needed if instantiated
364364
with :class:`~scrapinghub.client.spiders.Spider`).
365-
:param \*\*params: (optional) additional keyword args.
365+
:param params: (optional) additional keyword args.
366366
:return: a generator object over a list of dictionaries of jobs summary
367367
for a given filter params.
368368
:rtype: :class:`types.GeneratorType[dict]`
@@ -512,7 +512,7 @@ def close_writers(self):
512512
def start(self, **params):
513513
"""Move job to running state.
514514
515-
:param \*\*params: (optional) keyword meta parameters to update.
515+
:param params: (optional) keyword meta parameters to update.
516516
:return: a previous string job state.
517517
:rtype: :class:`str`
518518
@@ -526,7 +526,7 @@ def start(self, **params):
526526
def finish(self, **params):
527527
"""Move running job to finished state.
528528
529-
:param \*\*params: (optional) keyword meta parameters to update.
529+
:param params: (optional) keyword meta parameters to update.
530530
:return: a previous string job state.
531531
:rtype: :class:`str`
532532
@@ -540,7 +540,7 @@ def finish(self, **params):
540540
def delete(self, **params):
541541
"""Mark finished job for deletion.
542542
543-
:param \*\*params: (optional) keyword meta parameters to update.
543+
:param params: (optional) keyword meta parameters to update.
544544
:return: a previous string job state.
545545
:rtype: :class:`str`
546546
@@ -555,7 +555,7 @@ def update(self, state, **params):
555555
"""Update job state.
556556
557557
:param state: a new job state.
558-
:param \*\*params: (optional) keyword meta parameters to update.
558+
:param params: (optional) keyword meta parameters to update.
559559
:return: a previous string job state.
560560
:rtype: :class:`str`
561561

scrapinghub/client/logs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ def log(self, message, level=logging.INFO, ts=None, **other):
5555
:param message: a string message.
5656
:param level: (optional) logging level, default to INFO.
5757
:param ts: (optional) UNIX timestamp in milliseconds.
58-
:param \*\*other: other optional kwargs.
58+
:param other: other optional kwargs.
5959
"""
6060
self._origin.log(message, level=level, ts=ts, **other)
6161

0 commit comments

Comments
 (0)