Skip to content

Commit 2569886

Browse files
committed
lib.wiring: minor ReST syntax fixes.
1 parent d6bf47d commit 2569886

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

amaranth/lib/wiring.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ class Flow(enum.Enum):
2626
#: When used as the flow of a signature :class:`Member`, indicates that the data flow of
2727
#: the port members of the inner signature `remains the same`.
2828
#:
29-
#: When included in the ``signature`` property of an :class:`Elaboratable`, the signature
29+
#: When included in the :py:`signature` property of an :class:`Elaboratable`, the signature
3030
#: describes the elaboratable `driving` the corresponding signal. That is, the elaboratable is
3131
#: treated as the `initiator`.
3232
Out = "Out"
@@ -40,7 +40,7 @@ class Flow(enum.Enum):
4040
#: When used as the flow of a signature :class:`Member`, indicates that the data flow of
4141
#: the port members of the inner signature `is flipped`.
4242
#:
43-
#: When included in the ``signature`` property of an :class:`Elaboratable`, the signature
43+
#: When included in the :py:`signature` property of an :class:`Elaboratable`, the signature
4444
#: describes the elaboratable `sampling` the corresponding signal. That is, the elaboratable is
4545
#: treated as the `initiator`, the same as in the :attr:`Out` case.
4646
In = "In"
@@ -107,7 +107,7 @@ class Member:
107107
108108
When a :class:`Signal` is created from a description of a port member, the signal's initial value
109109
is taken from the member description. If this signal is never explicitly assigned a value, it
110-
will equal ``init``.
110+
will equal :py:`init`.
111111
112112
Although instances can be created directly, most often they will be created through
113113
:data:`In` and :data:`Out`, e.g. :py:`In(unsigned(1))` or :py:`Out(stream.Signature(RGBPixel))`.
@@ -825,7 +825,7 @@ def is_compliant(self, obj, *, reasons=None, path=("obj",)):
825825
It verifies that:
826826
827827
* :py:`obj` has a :py:`signature` attribute whose value a :class:`Signature` instance
828-
such that ``self == obj.signature``;
828+
such that :py:`self == obj.signature`;
829829
* for each member, :py:`obj` has an attribute with the same name, whose value:
830830
831831
* for members with :meth:`dimensions <Member.dimensions>` specified, contains a list or
@@ -1119,7 +1119,7 @@ def __getattr__(self, name):
11191119
return getattr(self.__unflipped, name)
11201120

11211121
def __setattr__(self, name, value):
1122-
"""Assigns attribute :py:`name` of the unflipped signature to ``value``.
1122+
"""Assigns attribute :py:`name` of the unflipped signature to :py:`value`.
11231123
11241124
Performs :py:`setattr(unflipped, name, value)`, ensuring that, if :py:`name` refers to
11251125
a property setter, its :py:`self` argument receives the flipped signature.
@@ -1296,7 +1296,7 @@ def __getattr__(self, name):
12961296
return getattr(self.__unflipped, name)
12971297

12981298
def __setattr__(self, name, value):
1299-
"""Assigns attribute :py:`name` of the unflipped interface to ``value``.
1299+
"""Assigns attribute :py:`name` of the unflipped interface to :py:`value`.
13001300
13011301
Performs :py:`setattr(unflipped, name, value)`, with the following caveats:
13021302

0 commit comments

Comments
 (0)