diff options
Diffstat (limited to 'pyecsca/ec/configuration.py')
| -rw-r--r-- | pyecsca/ec/configuration.py | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/pyecsca/ec/configuration.py b/pyecsca/ec/configuration.py index d92486d..e14b182 100644 --- a/pyecsca/ec/configuration.py +++ b/pyecsca/ec/configuration.py @@ -1,6 +1,4 @@ -""" -This module provides a way to work with and enumerate implementation configurations. -""" +"""This module provides a way to work with and enumerate implementation configurations.""" from dataclasses import dataclass from enum import Enum from itertools import product @@ -117,13 +115,14 @@ class Configuration(object): def all_configurations(**kwargs) -> Generator[Configuration, Configuration, None]: """ Get all implementation configurations that match the given `kwargs`. - The keys in `kwargs` should be some of the attributes in the :py:class:`Configuration`, + + The keys in :paramref:`~.all_configurations.kwargs` should be some of the attributes in the :py:class:`Configuration`, and the values limit the returned configurations to configuration matching them. .. note:: - The `formulas` attribute is unsupported and formulas should be provided using the `scalarmult` - attribute, which is either a subclass of the :py:class:`ScalarMultiplier` class or an instance - of it or a dictionary giving arguments to a constructor of some :py:class:`ScalarMultiplier` + The ``formulas`` attribute is unsupported and formulas should be provided using the ``scalarmult`` + attribute, which is either a subclass of the :py:class:`~.mult.ScalarMultiplier` class or an instance + of it or a dictionary giving arguments to a constructor of some :py:class:`~.mult.ScalarMultiplier` subclass. .. warning:: @@ -131,7 +130,7 @@ def all_configurations(**kwargs) -> Generator[Configuration, Configuration, None memory space. :param kwargs: The configuration parameters to match. - :return: A generator of the configurations + :return: A generator of the configurations. """ def is_optional(arg_type): |