From e694075c7fdcc9c4579d55b792da7a1391401b35 Mon Sep 17 00:00:00 2001 From: Sander Vrijders Date: Tue, 27 Mar 2018 16:40:59 +0200 Subject: testbeds, prototypes, model: Add docstrings This adds docstrings for methods of in the testbeds, prototypes and certain things in the model. --- rumba/prototypes/ouroboros.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'rumba/prototypes/ouroboros.py') diff --git a/rumba/prototypes/ouroboros.py b/rumba/prototypes/ouroboros.py index 97f6e1a..dfbde9b 100644 --- a/rumba/prototypes/ouroboros.py +++ b/rumba/prototypes/ouroboros.py @@ -38,11 +38,21 @@ import rumba.testbeds.dockertb as docker logger = log.get_logger(__name__) -# An experiment over the Ouroboros implementation class Experiment(mod.Experiment): + """ + Represents an Ouroboros experiment. + """ def __init__(self, testbed, nodes=None, git_repo='git://ouroboros.ilabt.imec.be/ouroboros', git_branch='master'): + """ + Initializes the experiment class. + + :param testbed: The testbed to run the experiment on. + :param nodes: The list of nodes. + :param git_repo: The git repository to use for installation. + :param git_branch: The branch of the git repository to use. + """ mod.Experiment.__init__(self, testbed, nodes, git_repo, git_branch) self.r_ipcps = dict() -- cgit v1.2.3