aboutsummaryrefslogtreecommitdiffhomepage
path: root/pyecsca/sca/trace/trace.py
diff options
context:
space:
mode:
authorJ08nY2021-04-11 14:16:57 +0200
committerJ08nY2021-04-11 14:16:57 +0200
commit942c0fb9d6fcbff7c91c553211cc81c7e0939e4e (patch)
tree1df80da6030019ef2a7490d2b2050a7d4b9a83ec /pyecsca/sca/trace/trace.py
parenta2e01e037fcde3e63571633e94156e324a4f2299 (diff)
downloadpyecsca-942c0fb9d6fcbff7c91c553211cc81c7e0939e4e.tar.gz
pyecsca-942c0fb9d6fcbff7c91c553211cc81c7e0939e4e.tar.zst
pyecsca-942c0fb9d6fcbff7c91c553211cc81c7e0939e4e.zip
Make docstring style changes as per pydocstyle.
Diffstat (limited to 'pyecsca/sca/trace/trace.py')
-rw-r--r--pyecsca/sca/trace/trace.py16
1 files changed, 5 insertions, 11 deletions
diff --git a/pyecsca/sca/trace/trace.py b/pyecsca/sca/trace/trace.py
index 68259c2..27462c7 100644
--- a/pyecsca/sca/trace/trace.py
+++ b/pyecsca/sca/trace/trace.py
@@ -1,6 +1,4 @@
-"""
-This module provides the Trace class.
-"""
+"""This module provides the Trace class."""
import weakref
from typing import Any, Mapping, Sequence
from copy import copy, deepcopy
@@ -12,7 +10,7 @@ from public import public
@public
class Trace(object):
- """A trace, which has some samples and metadata."""
+ """Trace, which has some samples and metadata."""
meta: Mapping[str, Any]
samples: ndarray
@@ -51,18 +49,14 @@ class Trace(object):
@property
def trace_set(self) -> Any:
- """
- The trace set this trace is contained in, if any.
- """
+ """Return the trace set this trace is contained in, if any."""
if self._trace_set is None:
return None
return self._trace_set()
@trace_set.setter
def trace_set(self, trace_set: Any):
- """
- Set the trace set of this trace.
- """
+ """Set the trace set of this trace."""
if trace_set is None:
self._trace_set = None
else:
@@ -107,7 +101,7 @@ class Trace(object):
@public
class CombinedTrace(Trace):
- """A trace that was combined from other traces, `parents`."""
+ """Trace that was combined from other traces, :paramref:`~.CombinedTrace.parents`."""
def __init__(
self,