reonokiy/swh-lister
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix various Sphinx warnings

Browse source
This commit is contained in:
Valentin Lorentz 2021-04-13 21:56:08 +02:00
parent 465506a0ce
commit 40e1916510
2 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/tutorial.rst
View file

@ -200,7 +200,7 @@ This datatype can also further be detailed with the optional fields:
scheduler for optimizing its scheduling decisions. Fill it if provided by the service,
at no substantial additional runtime cost, e.g. in the same request.
* extra loader arguments: extra parameters to be passed to the loader for it to be
* extra loader arguments: extra parameters to be passed to the loader for it to be
able to load the origin. It is needed for example when additional context is needed
along with the URL to effectively load from the origin.

7
swh/lister/pattern.py
View file

@ -145,11 +145,12 @@ class Lister(Generic[StateType, PageType]):
return self.state_from_dict(self.lister_obj.current_state)
def set_state_in_scheduler(self) -> None:
"""Update the state in the scheduler backend from the state of the current instance.
"""Update the state in the scheduler backend from the state of the current
instance.
Raises:
:class:`swh.scheduler.exc.StaleData` in case of a race condition between
concurrent listers (from :meth:`swh.scheduler.Scheduler.update_lister`).
swh.scheduler.exc.StaleData: in case of a race condition between
concurrent listers (from :meth:`swh.scheduler.Scheduler.update_lister`).
"""
self.lister_obj.current_state = self.state_to_dict(self.state)
self.lister_obj = self.scheduler.update_lister(self.lister_obj)