usb-tools/amaranth
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

hdl.ast: improve style of {Shape,Value}Castable doc. NFC.

Browse source
This commit is contained in:
Catherine 2022-04-06 05:19:45 +00:00
parent bf16acf2f0
commit 90fcbfc357
1 changed files with 17 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
amaranth/hdl/ast.py
View file

@ -35,10 +35,10 @@ class DUID:
class ShapeCastable: class ShapeCastable:
"""Interface of user-defined objects that can be cast to :class:`Shape` s. """Interface of user-defined objects that can be cast to :class:`Shape` s.
An object deriving from ``ShapeCastable`` is automatically converted to a ``Shape`` when it is An object deriving from :class:`ShapeCastable` is automatically converted to a :class:`Shape`
used in a context where a ``Shape`` is expected. Such objects can contain a richer description when it is used in a context where a :class:`Shape` is expected. Such objects can contain
of the shape than what is supported by the core Amaranth language, yet still be transparently a richer description of the shape than what is supported by the core Amaranth language, yet
used with it. still be transparently used with it.
""" """
def __new__(cls, *args, **kwargs): def __new__(cls, *args, **kwargs):
self = super().__new__(cls) self = super().__new__(cls)
@ -1312,19 +1312,19 @@ class UserValue(Value):
class ValueCastable: class ValueCastable:
"""Interface of user-defined objects that can be cast to :class:`Value` s. """Interface of user-defined objects that can be cast to :class:`Value` s.
An object deriving from ``ValueCastable`` is automatically converted to a ``Value`` when it is An object deriving from :class:`ValueCastable`` is automatically converted to a :class:`Value`
used in a context where a ``Value`` is expected. Such objects can implement different or when it is used in a context where a :class:`Value`` is expected. Such objects can implement
richer semantics than what is supported by the core Amaranth language, yet still be different or richer semantics than what is supported by the core Amaranth language, yet still
transparently used with it as long as the final underlying representation is a single Amaranth be transparently used with it as long as the final underlying representation is a single
``Value``. These objects also need not commit to a specific representation until they are Amaranth :class:`Value`. These objects also need not commit to a specific representation until
converted to a concrete Amaranth value. they are converted to a concrete Amaranth value.
Note that it is necessary to ensure that Amaranth's view of representation of all values stays Note that it is necessary to ensure that Amaranth's view of representation of all values stays
internally consistent. The class deriving from ``ValueCastable`` must decorate the ``as_value`` internally consistent. The class deriving from :class:`ValueCastable`` must decorate
method with the ``lowermethod`` decorator, which ensures that all calls to ``as_value`` return the :meth:`as_value` method with the :meth:`lowermethod` decorator, which ensures that all
the same ``Value`` representation. If the class deriving from ``ValueCastable`` is mutable, calls to :meth:`as_value` return the same :class:`Value` representation. If the class deriving
it is up to the user to ensure that it is not mutated in a way that changes its representation from :class:`ValueCastable` is mutable, it is up to the user to ensure that it is not mutated
after the first call to ``as_value``. in a way that changes its representation after the first call to :meth:`as_value`.
""" """
def __new__(cls, *args, **kwargs): def __new__(cls, *args, **kwargs):
self = super().__new__(cls) self = super().__new__(cls)