diff options
| author | Kapileshwar Singh <kapileshwar.singh@arm.com> | 2015-09-10 00:41:05 +0100 |
|---|---|---|
| committer | Javi Merino <javi.merino@arm.com> | 2015-09-17 16:18:25 +0100 |
| commit | d70501e7301908b2196632e827c9cec638f16efb (patch) | |
| tree | 2a3cebf271d371ef4989e08f8db982b66921e018 /trappy/wa/__init__.py | |
| parent | 6e2695ccea2f677ccdf3c5d1150af5e9b5ceff69 (diff) | |
| download | trappy-d70501e7301908b2196632e827c9cec638f16efb.tar.gz | |
doc: wa: Add sphinx friendly docstrings
Signed-off-by: Kapileshwar Singh <kapileshwar.singh@arm.com>
Diffstat (limited to 'trappy/wa/__init__.py')
| -rw-r--r-- | trappy/wa/__init__.py | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/trappy/wa/__init__.py b/trappy/wa/__init__.py index 639b8ee..f194387 100644 --- a/trappy/wa/__init__.py +++ b/trappy/wa/__init__.py @@ -12,7 +12,15 @@ # See the License for the specific language governing permissions and # limitations under the License. # +"""A helper module to extract data from WorkloadAutomation +output directories. WorkloadAutomation is a tool for +automating the execution of workloads. For more information +please visit https://github.com/ARM-software/workload-automation +.. note:: + + TRAPpy does not have a dependency on workload automation +""" from trappy.wa.results import Result, get_results, combine_results from trappy.wa.sysfs_extractor import SysfsExtractor |