aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarco Capitani <[email protected]>2018-03-29 14:45:58 +0200
committerMarco Capitani <[email protected]>2018-03-29 14:45:58 +0200
commit6a32967e2de49eaee359f29a482e19b3238f5016 (patch)
tree86a0c5cfc1edd735fb63f37ecd2c7a697d63043c /doc
parent74265717dcb72ee5e6abf54f7b67ba9d2658e0ed (diff)
downloadrumba-6a32967e2de49eaee359f29a482e19b3238f5016.tar.gz
rumba-6a32967e2de49eaee359f29a482e19b3238f5016.zip
storyboard: add/format docstrings
Also: + small docstring fixes in model + docstring fixes in log + log refactoring + other small refactoring + some small documentation fixes
Diffstat (limited to 'doc')
-rw-r--r--doc/log.rst2
-rw-r--r--doc/utils.rst2
-rw-r--r--doc/workflow.rst6
3 files changed, 6 insertions, 4 deletions
diff --git a/doc/log.rst b/doc/log.rst
index 1fd3b6f..d19bc13 100644
--- a/doc/log.rst
+++ b/doc/log.rst
@@ -8,3 +8,5 @@ Logging
.. autofunction:: rumba.log.flush_and_kill_logging
.. autofunction:: rumba.log.flush_log
+
+.. autoclass:: rumba.log.LogOptions
diff --git a/doc/utils.rst b/doc/utils.rst
index 6df8a0c..cc3db41 100644
--- a/doc/utils.rst
+++ b/doc/utils.rst
@@ -8,6 +8,8 @@ Example usage of the class:
.. code-block:: python
+ from rumba.utils import ExperimentManager, PROMPT_SWAPOUT
+
with ExperimentManager(exp, swap_out_strategy=PROMPT_SWAPOUT):
exp.swap_in()
exp.bootstrap_prototype()
diff --git a/doc/workflow.rst b/doc/workflow.rst
index 04f23b1..672c33c 100644
--- a/doc/workflow.rst
+++ b/doc/workflow.rst
@@ -34,11 +34,9 @@ Workflow
Accessing nodes after swap-in
-----------------------------
-To access a node once the experiment swapped in, use the following
+To access a node once the experiment is swapped in, use the following
command (in the same terminal where ssh-agent was run in case of jFed): ::
$ rumba-access $NODE_NAME
-Where $NODE_NAME is the name of the node to access. In case of the
-QEMU testbed, the password of the downloaded buildroot images is
-'root'.
+Where $NODE_NAME is the name of the node to access. \ No newline at end of file