From de4e15e07a073b3a83fcce65f31fdd3b4ab56f99 Mon Sep 17 00:00:00 2001 From: jgart Date: Tue, 7 Mar 2023 18:02:30 +0100 Subject: [PATCH] Clarify docstring and mention subclassing of run method --- sphinxcontrib/collections/drivers/__init__.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/sphinxcontrib/collections/drivers/__init__.py b/sphinxcontrib/collections/drivers/__init__.py index d44aa33..4d673cd 100644 --- a/sphinxcontrib/collections/drivers/__init__.py +++ b/sphinxcontrib/collections/drivers/__init__.py @@ -26,11 +26,11 @@ def __init__(self, collection, config=None): def run(self): """ - Is the main routine for the driver. + This is the main routine for the driver. - Must be implement by the parent driver class. + The run method must be implement by the subclassed driver. """ - raise NotImplementedError("run() function must be implemented by driver {} itself.".format(self.name)) + raise NotImplementedError("run() function must be implemented by the driver {} itself.".format(self.name)) def clean(self): """