diff options
| author | J08nY | 2025-03-19 14:48:38 +0100 |
|---|---|---|
| committer | J08nY | 2025-03-19 14:48:38 +0100 |
| commit | f50335f62ff4ebd4ea855597357f1d7a6df8eef8 (patch) | |
| tree | 07074876090a99c59c844ac0b79df0414b870ce3 | |
| parent | 25e07e0ae5f74f05edbdd5026a51417333b4679c (diff) | |
| download | pyecsca-f50335f62ff4ebd4ea855597357f1d7a6df8eef8.tar.gz pyecsca-f50335f62ff4ebd4ea855597357f1d7a6df8eef8.tar.zst pyecsca-f50335f62ff4ebd4ea855597357f1d7a6df8eef8.zip | |
Cleanup docs from unnecessary inherited items.
| -rw-r--r-- | docs/conf.py | 4 | ||||
| -rw-r--r-- | pyecsca/ec/formula/fake.py | 2 | ||||
| -rw-r--r-- | pyecsca/sca/trace/combine.py | 14 |
3 files changed, 10 insertions, 10 deletions
diff --git a/docs/conf.py b/docs/conf.py index ed9407f..a759ece 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,7 +21,7 @@ sys.path.insert(0, os.path.abspath('../notebook/')) # -- Project information ----------------------------------------------------- project = 'pyecsca' -copyright = '2018-2024, Jan Jancar' +copyright = '2018-2025, Jan Jancar' author = 'Jan Jancar' sys.path.append(os.path.abspath('..')) @@ -222,7 +222,7 @@ todo_include_todos = True autodoc_default_options = { "members": True, "undoc-members": True, - "inherited-members": True, + "inherited-members": "object, int, float, str, list, dict, set", "show-inheritance": True, "member-order": "bysource", # "special-members": "__init__" diff --git a/pyecsca/ec/formula/fake.py b/pyecsca/ec/formula/fake.py index 8b71df6..0a3451b 100644 --- a/pyecsca/ec/formula/fake.py +++ b/pyecsca/ec/formula/fake.py @@ -26,7 +26,7 @@ class FakeFormula(Formula, ABC): No matter what the input point is, it just returns the right amount of FakePoints. Useful for computing with the scalar multipliers without having concrete formulas - and points (for example to get the addition chain via the MultipleContext). + and points (for example to get the addition chain via the :py:class:`~.MultipleContext`). """ def __init__(self, coordinate_model): diff --git a/pyecsca/sca/trace/combine.py b/pyecsca/sca/trace/combine.py index 7d751e2..50a99ca 100644 --- a/pyecsca/sca/trace/combine.py +++ b/pyecsca/sca/trace/combine.py @@ -11,7 +11,7 @@ from pyecsca.sca.trace.trace import Trace, CombinedTrace @public def average(*traces: Trace) -> CombinedTrace: """ - Average :paramref:`~.average.traces`, sample-wise. + Average :paramref:`~.combine.average.traces`, sample-wise. :param traces: :return: @@ -34,7 +34,7 @@ def conditional_average( *traces: Trace, condition: Callable[[Trace], bool] ) -> CombinedTrace: """ - Average :paramref:`~.conditional_average.traces` for which the :paramref:`~.conditional_average.condition` is ``True``, sample-wise. + Average :paramref:`~.combine.conditional_average.traces` for which the :paramref:`~.combine.conditional_average.condition` is ``True``, sample-wise. :param traces: :param condition: @@ -46,7 +46,7 @@ def conditional_average( @public def standard_deviation(*traces: Trace) -> CombinedTrace: """ - Compute the sample standard-deviation of the :paramref:`~.standard_deviation.traces`, sample-wise. + Compute the sample standard-deviation of the :paramref:`~.combine.standard_deviation.traces`, sample-wise. :param traces: :return: @@ -73,7 +73,7 @@ def standard_deviation(*traces: Trace) -> CombinedTrace: @public def variance(*traces: Trace) -> CombinedTrace: """ - Compute the sample variance of the :paramref:`~.variance.traces`, sample-wise. + Compute the sample variance of the :paramref:`~.combine.variance.traces`, sample-wise. :param traces: :return: @@ -100,7 +100,7 @@ def variance(*traces: Trace) -> CombinedTrace: @public def average_and_variance(*traces) -> Tuple[CombinedTrace, CombinedTrace]: """ - Compute the average and sample variance of the :paramref:`~.average_and_variance.traces`, sample-wise. + Compute the average and sample variance of the :paramref:`~.combine.average_and_variance.traces`, sample-wise. :param traces: :return: @@ -129,7 +129,7 @@ def average_and_variance(*traces) -> Tuple[CombinedTrace, CombinedTrace]: @public def add(*traces: Trace) -> CombinedTrace: """ - Add :paramref:`~.add.traces`, sample-wise. + Add :paramref:`~.combine.add.traces`, sample-wise. :param traces: :return: @@ -148,7 +148,7 @@ def add(*traces: Trace) -> CombinedTrace: @public def subtract(one: Trace, other: Trace) -> CombinedTrace: """ - Subtract :paramref:`~.subtract.other` from :paramref:`~.subtract.one`, sample-wise. + Subtract :paramref:`~.combine.subtract.other` from :paramref:`~.combine.subtract.one`, sample-wise. :param one: :param other: |
