summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSteve Kemp <steve@steve.org.uk>2012-11-14 17:55:43 +0000
committerSteve Kemp <steve@steve.org.uk>2012-11-14 17:55:43 +0000
commit9b9abc5c965c4fb88f56f0bec91faa4d46b9e100 (patch)
treed153d3ff1476222f1a468faf4243dbce09646ffe
parentbd226f9b916fe9a8b7ab2edce1fb7465fa5f8f7a (diff)
Updated comments.
-rwxr-xr-xlib/custodian/parser.rb15
1 files changed, 10 insertions, 5 deletions
diff --git a/lib/custodian/parser.rb b/lib/custodian/parser.rb
index d02ffb6..7ed7a51 100755
--- a/lib/custodian/parser.rb
+++ b/lib/custodian/parser.rb
@@ -16,15 +16,13 @@ require 'uri'
#
# This is a simple class which will parse a sentinel configuration file.
#
-# Unlike Sentinel it is not using a real parser, instead it peels off lines
+# Unlike Sentinel it is not built using a real parser, instead it peels off lines
# via a small number of very simple regular expressions - this should be flaky,
# but in practice it manages to successfully parse each of the configuration
# files that we currently maintain @ Bytemark.
#
-# TODO:
-#
-# 1. Explicitly abort and panic on malformed lines.
-#
+# If there are any lines which are not recognized the class will terminate
+# with an error.
#
# Steve
# --
@@ -69,10 +67,17 @@ class MonitorConfig
end
+ #
+ # Get the current value of the timeout figure.
+ #
def get_timeout()
@timeout
end
+
+ #
+ # Set the timeout value.
+ #
def set_timeout( new_val )
@timeout = new_val
end