diff options
author | Kapileshwar Singh <kapileshwar.singh@arm.com> | 2015-09-21 16:56:20 +0100 |
---|---|---|
committer | Kapileshwar Singh <kapileshwar.singh@arm.com> | 2015-09-23 18:02:28 +0100 |
commit | 5f386027426e575d3f51af1cb44042b599fb0d41 (patch) | |
tree | dffbd6b30d8f061dc453aa056db84f9688ddfb4c /bart | |
parent | 81361c2a1370d30b82d0598fb97a0d96b9366043 (diff) | |
download | bart-5f386027426e575d3f51af1cb44042b599fb0d41.tar.gz |
doc: Utils: Add Sphinx friendly docstrings
Signed-off-by: Kapileshwar Singh <kapileshwar.singh@arm.com>
Diffstat (limited to 'bart')
-rw-r--r-- | bart/common/Utils.py | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/bart/common/Utils.py b/bart/common/Utils.py index ecb83d3..7a1a3b4 100644 --- a/bart/common/Utils.py +++ b/bart/common/Utils.py @@ -18,7 +18,12 @@ import trappy def init_run(trace): - """Initialize the Run Object""" + """Initialize the Run Object + + :param trace: Path for the trace file + or a trace object + :type trace: str, :mod:`trappy.run.Run` + """ if isinstance(trace, basestring): return trappy.Run(trace) @@ -29,8 +34,14 @@ def init_run(trace): raise ValueError("Invalid trace Object") def select_window(series, window): - """Library Function to select a portion of - pandas time series + """Helper Function to select a portion of + pandas time series + + :param series: Input Time Series data + :type series: :mod:`pandas.Series` + + :param window: A tuple indicating a time window + :type window: tuple """ if not window: |