Commit 09f28cb9 authored by GromeTT's avatar GromeTT
Browse files

ENH: Improved documentation

parent c3fcdb85
......@@ -6,7 +6,8 @@
class AcceptsFellingJobs(AcceptsJobs):
"""This functionality signalizes that FellingJobs can be processed."""
"""This functionality signalizes that FellingJobs can be processed and
offers the possibility to remove and query it."""
def __init__(self, name="", identifier=""):
"""Initializes the object.
......@@ -15,15 +16,17 @@ def __init__(self, name="", identifier=""):
:param identifier: Identifier
"""
super().__init__(
name=name,
identifier=identifier)
def acceptJob(self, job: FellingJob) -> bool:
"""Accepts the given FellingJob job.
"""Accepts the given FellingJob job. Returns true if the job has been
accepted, otherwise returns false.
:param job: FellingJob to be accepted
:return:
:rtype: bool
"""
pass
......@@ -31,17 +34,19 @@ def acceptJob(self, job: FellingJob) -> bool:
def queryJobStatus(self, identifier) -> JobStatus:
"""Returns the status of the job whose id is identical to identifier.
:param identifier: Identifier of the job to be queried.
:return: Status of the jobs
:param identifier: Identifier of the job to be queried
:return: Status of the job
:rtype: JobStatus
"""
pass
def removeJob(self, identifier) -> bool:
""" Removes the job with the id identical to identifier.
"""Removes the job with the id identical to identifier. Returns true
if the job has been removed, otherwise returns false.
:param identifier: Identifier of the job to be deleted
:rtype: bool
"""
pass
......@@ -20,9 +20,10 @@ def __init__(self, name="", identifier=""):
identifier=identifier)
def acceptJob(self, job: FellingSupportJob) -> bool:
"""Accepts the given FellingSupportJob job.
"""Accepts the given FellingSupportJob job. Returns true if the job
has been accepted, otherwise returns false.
:param job: FellingSupportJob to be accepted
:rtype: bool
"""
pass
......@@ -21,9 +21,11 @@ def __init__(self, name="", identifier=""):
identifier=identifier)
def acceptJob(self, job: ForwardingJob) -> bool:
"""Accepts the given Forwardingjob.
"""Accepts the given ForwardingJob. Returns true if the job has been
accepted, otherwise returns false.
:param job: ForwardingJob to be accepted
:rtype: bool
"""
pass
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment