Minor doc fixes

This commit is contained in:
Anders Ingemann 2014-03-23 19:37:25 +01:00
parent 6c0e9b1692
commit 18dfefe560
4 changed files with 8 additions and 4 deletions

View file

@ -35,6 +35,7 @@ class AbstractPartition(FSMProxy):
def mount(self, prefix): def mount(self, prefix):
"""Performs the mount operation or forwards it to another partition """Performs the mount operation or forwards it to another partition
Args: Args:
prefix (str): Path prefix of the mountpoint prefix (str): Path prefix of the mountpoint
""" """

View file

@ -5,6 +5,7 @@ class Phase(object):
It has no function other than to act as an anchor in the task graph. It has no function other than to act as an anchor in the task graph.
All phases are instantiated in common.phases All phases are instantiated in common.phases
""" """
def __init__(self, name, description): def __init__(self, name, description):
# The name of the phase # The name of the phase
self.name = name self.name = name
@ -13,6 +14,7 @@ class Phase(object):
def pos(self): def pos(self):
"""Gets the position of the phase """Gets the position of the phase
Returns: Returns:
int. The positional index of the phase in relation to the other phases int. The positional index of the phase in relation to the other phases
""" """

View file

@ -1,7 +1,7 @@
class Task(object): class Task(object):
"""The task class represents are task that can be run. """The task class represents a task that can be run.
It is merely a wrapper for the run function and should never be instantiated. It is merely a wrapper for the run function and should never be instantiated.
""" """
# The phase this task is located in. # The phase this task is located in.
@ -31,7 +31,8 @@ class Task(object):
@classmethod @classmethod
def run(cls, info): def run(cls, info):
"""The run function, all work is done inside this function """The run function, all work is done inside this function
Args:
info (BootstrapInformation): The bootstrap info object :param info: The bootstrap info object.
:type info: BootstrapInformation
""" """
pass pass

View file

@ -25,7 +25,7 @@ class TaskList(object):
Args: Args:
function (str): Name of the function to call function (str): Name of the function to call
manifest (Manifest): The manifest manifest (Manifest): The manifest
*args: Additional arguments that should be passed to the function that is called \*args: Additional arguments that should be passed to the function that is called
""" """
# Call 'function' on the provider # Call 'function' on the provider
getattr(manifest.modules['provider'], function)(self.tasks, manifest, *args) getattr(manifest.modules['provider'], function)(self.tasks, manifest, *args)