From 8a784331c1fcf81541d1ae515536255d12707cdc Mon Sep 17 00:00:00 2001 From: Bryan Herman Date: Mon, 8 Apr 2013 08:29:53 -0400 Subject: [PATCH] added docstring for extract_results method --- src/utils/statepoint.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/utils/statepoint.py b/src/utils/statepoint.py index 6732607ea8..f8dd76ada6 100644 --- a/src/utils/statepoint.py +++ b/src/utils/statepoint.py @@ -441,6 +441,18 @@ class StatePoint(object): return t.results[filter_index, score_index] def extract_results(self, tally_id, score_str): + """Returns a tally results dictionary given a tally_id and score string. + + Parameters + ---------- + tally_id : int + Index for the tally in StatePoint.tallies list + + score_str : string + Corresponds to the string entered for a score in tallies.xml. + For a flux score extraction it would be 'score' + + """ # get tally try: