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

docs/lang: use less confusing placeholder variable names.

Browse source 
Fixes #474.
This commit is contained in:
whitequark 2020-08-15 13:00:50 +00:00
parent 73f672f57c
commit e46118dac0
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/lang.rst
View file

@ -625,10 +625,10 @@ Operation Description Notes
``len(a)`` bit length; value width [#opS1]_
``a[i:j:k]`` bit slicing by constant subscripts [#opS2]_
``iter(a)`` bit iteration
``a.bit_select(b, i)`` overlapping part select with variable offset
``a.word_select(b, i)`` non-overlapping part select with variable offset
``a.bit_select(b, w)`` overlapping part select with variable offset
``a.word_select(b, w)`` non-overlapping part select with variable offset
``Cat(a, b)`` concatenation [#opS3]_
``Repl(a, i)`` replication
``Repl(a, n)`` replication
======================= ================================================ ======
.. [#opS1] Words "length" and "width" have the same meaning when talking about nMigen values. Conventionally, "width" is used.
@ -641,9 +641,9 @@ For the operators introduced by nMigen, the following table explains them in ter
nMigen operation Equivalent Python code
======================= ======================
``Cat(a, b)`` ``a + b``
``Repl(a, i)`` ``a * i``
``a.bit_select(b, i)`` ``a[b:b+i]``
``a.word_select(b, i)`` ``a[b*i:b*i+i]``
``Repl(a, n)`` ``a * n``
``a.bit_select(b, w)`` ``a[b:b+w]``
``a.word_select(b, w)`` ``a[b*w:b*w+w]``
======================= ======================
.. warning::