Skip to content

Commit

Permalink
Fill in a little more documentation
Browse files Browse the repository at this point in the history
A few spots that seemed empty once I was actually looking at the API
docs on RTD.
  • Loading branch information
dwhswenson committed Sep 28, 2023
1 parent b742046 commit 520525e
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions exorcist/taskdb.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ class NoStatusChange(Exception):


class AbstractTaskStatusDB(abc.ABC):
"""Abstract class defining API for a task status database
"""
@abc.abstractmethod
def add_task(self, taskid: str, requirements: Iterable[str],
max_tries: int):
Expand Down Expand Up @@ -164,10 +166,12 @@ def __repr__(self):

@property
def tasks_table(self):
"""SQLAlchemy table for ``tasks``"""
return self.metadata.tables['tasks']

@property
def dependencies_table(self):
"""SQLAlchemy table for ``depedencies``"""
return self.metadata.tables['dependencies']

def get_all_tasks(self) -> Iterable[sqla.Row]:
Expand Down

0 comments on commit 520525e

Please sign in to comment.