From b1bb85611ad31100162c3c5d07ffcb401826c440 Mon Sep 17 00:00:00 2001 From: Brendan Jackman Date: Mon, 27 Feb 2017 11:19:19 +0000 Subject: [PATCH] trace: Note in docstring that get{Cpu|Cluster}ActiveSignal may return None --- libs/utils/trace.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/libs/utils/trace.py b/libs/utils/trace.py index 7d068c348..da58cdd78 100644 --- a/libs/utils/trace.py +++ b/libs/utils/trace.py @@ -820,7 +820,8 @@ class Trace(object): :param cpu: CPU ID :type cpu: int - :returns: :mod:`pandas.Series` + :returns: A :mod:`pandas.Series` or ``None`` if the trace contains no + "cpu_idle" events """ if not self.hasEvents('cpu_idle'): self._log.warning('Events [cpu_idle] not found, ' @@ -859,7 +860,8 @@ class Trace(object): :param cluster: list of CPU IDs belonging to a cluster :type cluster: list(int) - :returns: :mod:`pandas.Series` + :returns: A :mod:`pandas.Series` or ``None`` if the trace contains no + "cpu_idle" events """ if not self.hasEvents('cpu_idle'): self._log.warning('Events [cpu_idle] not found, ' -- GitLab