From 40e1916510c4b99d74792f5892664a474583c5a1 Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Tue, 13 Apr 2021 21:56:08 +0200 Subject: [PATCH] Fix various Sphinx warnings --- docs/tutorial.rst | 2 +- swh/lister/pattern.py | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/tutorial.rst b/docs/tutorial.rst index e254bcd..f3e6020 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -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. diff --git a/swh/lister/pattern.py b/swh/lister/pattern.py index 1a6b3e3..6f077e4 100644 --- a/swh/lister/pattern.py +++ b/swh/lister/pattern.py @@ -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)