Skip to content

Commit

Permalink
Clarify docstring and mention subclassing of run method
Browse files Browse the repository at this point in the history
  • Loading branch information
jgarte committed Mar 7, 2023
1 parent 99b3599 commit bbb49f8
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions sphinxcontrib/collections/drivers/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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):
"""
Expand Down

0 comments on commit bbb49f8

Please sign in to comment.