Skip to content

Commit 2dea83c

Browse files
committed
docs/reference: minor fixes.
1 parent 1dc1d2d commit 2dea83c

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

amaranth/hdl/_ast.py

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -459,13 +459,11 @@ def shape(self):
459459
Returns
460460
-------
461461
:ref:`shape-like object <lang-shapelike>`
462-
463-
..
464-
TODO: while this is documented as returning a shape-like object, in practice we
465-
guarantee that this is a concrete Shape. it's unclear whether we will ever want to
466-
return a shape-catable object here, but there is not much harm in stating a relaxed
467-
contract, as it can always be tightened later, but not vice-versa
468462
"""
463+
# TODO: while this is documented as returning a shape-like object, in practice we
464+
# guarantee that this is a concrete Shape. it's unclear whether we will ever want to
465+
# return a shape-catable object here, but there is not much harm in stating a relaxed
466+
# contract, as it can always be tightened later, but not vice-versa
469467
pass # :nocov:
470468

471469
def as_unsigned(self):
@@ -853,7 +851,7 @@ def __rxor__(self, other):
853851
return Operator("^", [other, self])
854852

855853
def xor(self):
856-
"""Reduction XOR; is an odd amount of bits :pc:`1`?
854+
"""Reduction XOR; are an odd amount of bits :pc:`1`?
857855
858856
Returns
859857
-------

0 commit comments

Comments
 (0)