Skip to content

Commit be6a12a

Browse files
committed
Minor documentation rewording, trying to better explain the differences between LogicNet.dests and Gate.dests.
1 parent 3b6491b commit be6a12a

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

pyrtl/gate_graph.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -120,21 +120,21 @@ class Gate:
120120
:attr:`Gate.bitwidth`. If the :class:`.LogicNet` produces no output, like a
121121
:class:`.MemBlock` write, the :class:`Gate`'s :attr:`~Gate.name` and
122122
:attr:`~Gate.bitwidth` will be ``None``. PyRTL does not have an
123-
:attr:`~.LogicNet.op` with multiple :attr:`~.LogicNet.dests`.
123+
:attr:`~.LogicNet.op` with multiple :attr:`.LogicNet.dests`.
124124
125-
3. The :class:`Gate` has a new :attr:`~Gate.dests` attribute, which has no direct
125+
3. The :class:`Gate` has a new :attr:`Gate.dests` attribute, which has no direct
126126
equivalent in the :class:`.LogicNet`/:class:`.WireVector` representation.
127-
:attr:`~Gate.dests` is a list of the :class:`Gates<Gate>` that use this
127+
:attr:`Gate.dests` is a list of the :class:`Gates<Gate>` that use this
128128
:class:`Gate`'s output as one of their :attr:`~Gate.args`.
129129
130130
:attr:`.LogicNet.dests` and :attr:`Gate.dests` represent slightly different things,
131131
despite having similar names:
132132
133133
- :attr:`.LogicNet.dests` represents the :class:`LogicNet`'s output wire. It is a
134134
list of :class:`WireVectors<.WireVector>` which hold the :class:`.LogicNet`'s
135-
output. There can be at most one :class:`WireVector` in :attr:`.LogicNet.dests`,
136-
but that :class:`.WireVector` can be an :attr:`arg<.LogicNet.args>` to any number
137-
of :class:`LogicNets<.LogicNet>`.
135+
output. There can only be zero or one :class:`WireVectors<.WireVector>` in
136+
:attr:`.LogicNet.dests`, but that :class:`.WireVector` can be an
137+
:attr:`arg<.LogicNet.args>` to any number of :class:`LogicNets<.LogicNet>`.
138138
139139
- :attr:`Gate.dests` represents the :class:`Gate`'s users. It is a list of
140140
:class:`Gates<Gate>` that use the :class:`Gate`'s output as one of their

0 commit comments

Comments
 (0)