Skip to content

Commit d77cd89

Browse files
lansergerobtaylor
authored andcommitted
Updated PinSignature docs with added links to Amaranth Signature class
1 parent 8aa52a6 commit d77cd89

File tree

1 file changed

+4
-10
lines changed

1 file changed

+4
-10
lines changed

chipflow_lib/platforms/utils.py

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ def as_json(self): # type: ignore
6666

6767

6868
class PinSignature(wiring.Signature):
69-
"""Amaranth Signature used to decorate wires that would usually be brought out onto a port on the package.
69+
"""An :py:obj:`Amaranth Signature <amaranth.lib.wiring.Signature>` used to decorate wires that would usually be brought out onto a port on the package.
7070
This class is generally not directly used.
7171
Instead, you would typically utilize the more specific
7272
:py:obj:`InputPinSignature`, :py:obj:`OutputPinSignature`, or :py:obj:`BidirPinSignature` for defining pin interfaces.
@@ -133,9 +133,7 @@ def __repr__(self):
133133

134134

135135
def OutputPinSignature(width, **kwargs):
136-
"""This creates Amaranth Signature used to decorate package output wires
137-
that would be connected to the pads on the package.
138-
This creates an Amaranth Signature which is then used to decorate output signals
136+
"""This creates an :py:obj:`Amaranth Signature <amaranth.lib.wiring.Signature>` which is then used to decorate package output signals
139137
intended for connection to the physical pads of the integrated circuit package.
140138
141139
:param width: specifies the number of individual output wires within this port, each of which will correspond to a separate physical pad on the integrated circuit package.
@@ -146,9 +144,7 @@ def OutputPinSignature(width, **kwargs):
146144

147145

148146
def InputPinSignature(width, **kwargs):
149-
"""This creates Amaranth Signature used to decorate package input wires
150-
that would be connected to the pads on the package.
151-
This creates an Amaranth Signature which is then used to decorate input signals
147+
"""This creates an :py:obj:`Amaranth Signature <amaranth.lib.wiring.Signature>` which is then used to decorate package input signals
152148
intended for connection to the physical pads of the integrated circuit package.
153149
154150
:param width: specifies the number of individual input wires within this port, each of which will correspond to a separate physical pad on the integrated circuit package.
@@ -159,9 +155,7 @@ def InputPinSignature(width, **kwargs):
159155

160156

161157
def BidirPinSignature(width, **kwargs):
162-
"""This creates Amaranth Signature used to decorate package bidirectional wires
163-
that would be connected to the pads on the package.
164-
This creates an Amaranth Signature which is then used to decorate bi-directional signals
158+
"""This creates an :py:obj:`Amaranth Signature <amaranth.lib.wiring.Signature>` which is then used to decorate package bi-directional signals
165159
intended for connection to the physical pads of the integrated circuit package.
166160
167161
:param width: specifies the number of individual input/output wires within this port. Each pair of input/output wires will correspond to a separate physical pad on the integrated circuit package.

0 commit comments

Comments
 (0)