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

docs/reference: minor fixes.

Browse source
This commit is contained in:
Catherine 2024-02-13 04:47:25 +00:00
parent 1dc1d2d709
commit 2dea83cffd
1 changed files with 5 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
amaranth/hdl/_ast.py
View file

@ -459,13 +459,11 @@ class Value(metaclass=ABCMeta):
Returns Returns
------- -------
:ref:`shape-like object <lang-shapelike>` :ref:`shape-like object <lang-shapelike>`
..
TODO: while this is documented as returning a shape-like object, in practice we
guarantee that this is a concrete Shape. it's unclear whether we will ever want to
return a shape-catable object here, but there is not much harm in stating a relaxed
contract, as it can always be tightened later, but not vice-versa
""" """
# TODO: while this is documented as returning a shape-like object, in practice we
# guarantee that this is a concrete Shape. it's unclear whether we will ever want to
# return a shape-catable object here, but there is not much harm in stating a relaxed
# contract, as it can always be tightened later, but not vice-versa
pass # :nocov: pass # :nocov:
def as_unsigned(self): def as_unsigned(self):
@ -853,7 +851,7 @@ class Value(metaclass=ABCMeta):
return Operator("^", [other, self]) return Operator("^", [other, self])
def xor(self): def xor(self):
"""Reduction XOR; is an odd amount of bits :pc:`1`? """Reduction XOR; are an odd amount of bits :pc:`1`?
Returns Returns
------- -------