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

lib.data: fix documentation style. NFC

Browse source
This commit is contained in:
Catherine 2023-05-12 22:11:30 +00:00
parent 7166455a6a
commit ea5a150155
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
amaranth/lib/data.py
View file

@ -196,7 +196,7 @@ class Layout(ShapeCastable, metaclass=ABCMeta):
Returns Returns
------- -------
View :class:`View`
``View(self, target)`` ``View(self, target)``
""" """
return View(self, target) return View(self, target)
@ -297,7 +297,7 @@ class StructLayout(Layout):
Returns Returns
------- -------
int :class:`int`
Index of the most significant bit of the *last* field plus one; or zero if there are Index of the most significant bit of the *last* field plus one; or zero if there are
no fields. no fields.
""" """
@ -369,7 +369,7 @@ class UnionLayout(Layout):
Returns Returns
------- -------
int :class:`int`
Index of the most significant bit of the *largest* field plus one; or zero if there are Index of the most significant bit of the *largest* field plus one; or zero if there are
no fields. no fields.
""" """
@ -389,7 +389,7 @@ class ArrayLayout(Layout):
.. image:: _images/data/array_layout.svg .. image:: _images/data/array_layout.svg
can be described with:: can be described with:
.. testcode:: .. testcode::
@ -403,7 +403,7 @@ class ArrayLayout(Layout):
---------- ----------
elem_shape : :ref:`shape-castable <lang-shapecasting>` elem_shape : :ref:`shape-castable <lang-shapecasting>`
Shape of an individual element. Shape of an individual element.
length : int length : :class:`int`
Amount of elements. Amount of elements.
""" """
def __init__(self, elem_shape, length): def __init__(self, elem_shape, length):
@ -457,7 +457,7 @@ class ArrayLayout(Layout):
Returns Returns
------- -------
int :class:`int`
Size of an individual element multiplied by their amount. Size of an individual element multiplied by their amount.
""" """
return Shape.cast(self._elem_shape).width * self.length return Shape.cast(self._elem_shape).width * self.length
@ -491,7 +491,7 @@ class FlexibleLayout(Layout):
Attributes Attributes
---------- ----------
size : int size : :class:`int`
Size of the layout. Size of the layout.
fields : mapping of :class:`str` or :class:`int` to :class:`Field` fields : mapping of :class:`str` or :class:`int` to :class:`Field`
Fields defined in the layout. Fields defined in the layout.