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

docs: stdlib/memory: minor style improvement. NFC

Browse source
This commit is contained in:
Catherine 2024-06-06 03:13:08 +01:00
parent 48a2dc212b
commit 3c1060f7c7
2 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
amaranth/hdl/_mem.py
View file

@ -25,7 +25,8 @@ class MemoryData:
a default value for rows that are not explicitly initialized. a default value for rows that are not explicitly initialized.
Changing the initial contents of a :class:`MemoryData` is only possible until it is used to Changing the initial contents of a :class:`MemoryData` is only possible until it is used to
elaborate a memory; afterwards, attempting to do so will raise :exc:`AlreadyElaborated`. elaborate a memory; afterwards, attempting to do so will raise the :class:`AlreadyElaborated`
exception.
.. warning:: .. warning::
@ -510,7 +511,8 @@ class DummyPort:
any such attributes may be set manually. any such attributes may be set manually.
""" """
# TODO(amaranth-0.6): remove # TODO(amaranth-0.6): remove
@deprecated("`DummyPort` is deprecated, use `amaranth.lib.memory.ReadPort` or `amaranth.lib.memory.WritePort` instead") @deprecated("`DummyPort` is deprecated, use `amaranth.lib.memory.ReadPort` or "
"`amaranth.lib.memory.WritePort` instead")
def __init__(self, *, data_width, addr_width, domain="sync", name=None, granularity=None): def __init__(self, *, data_width, addr_width, domain="sync", name=None, granularity=None):
self.domain = domain self.domain = domain

3
amaranth/lib/memory.py
View file

@ -23,7 +23,8 @@ class Memory(wiring.Component):
the :ref:`elaborate <lang-elaboration>` method. the :ref:`elaborate <lang-elaboration>` method.
Adding ports or changing initial contents of a :class:`Memory` is only possible until it is Adding ports or changing initial contents of a :class:`Memory` is only possible until it is
elaborated; afterwards, attempting to do so will raise :class:`~amaranth.hdl.AlreadyElaborated`. elaborated; afterwards, attempting to do so will raise the
:class:`~amaranth.hdl.AlreadyElaborated` exception.
Platform overrides Platform overrides
------------------ ------------------