Skip to content
This repository was archived by the owner on Jan 29, 2024. It is now read-only.

Commit a2fdaec

Browse files
committed
Fix a few typos
- avaiable → available - essense → essence - publically → publicly (not strictly a typo but more common) - add a missing ',' in bus example
1 parent eb4e5d7 commit a2fdaec

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

3_modules.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ m2.d.thing += # this will fail
137137

138138
## Ports
139139

140-
The equivalent of ports in a module is public attributes. In the following example, `a` and `data` are publically available to other modules, while `b` is not, just as `a` and `data` are publically available to other Python classes, and `b` is not.
140+
The equivalent of ports in a module is public attributes. In the following example, `a` and `data` are publicly available to other modules, while `b` is not, just as `a` and `data` are publicly available to other Python classes, and `b` is not.
141141

142142
```python
143143
class ThingBlock(Elaboratable):

4_basicops.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ However, many math operators are overridable in Python, since these translate to
2929
| `<` | less than |
3030
| `<=` | less than or equal to |
3131

32-
Note that there are no translatable Python logical operators (`and`, `or`). The logical reduction functions `any` and `all` are also not avaiable in nMigen expressions. Attempts to use an nMigen value as a boolean will result in an error saying `Attempted to convert nMigen value to boolean`.
32+
Note that there are no translatable Python logical operators (`and`, `or`). The logical reduction functions `any` and `all` are also not available in nMigen expressions. Attempts to use an nMigen value as a boolean will result in an error saying `Attempted to convert nMigen value to boolean`.
3333

3434
Shift right is effectively arithmetic, where the sign bit is present for signed Values, or absent (or implicitly zero) for unsigned Values. Consider that if right shift is applied to a signed Value, the shift properly duplicates the sign bit. If it is applied to an unsigned Value, the shift is logical -- you could consider it an arithmetic shift where the "missing" sign bit is always zero. Because shift right on an unsigned Value is the same as logical shift right, `>>` is a logical shift right when applied to an unsigned Value.
3535

5_branching.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ If `platform` is `"this"` then only `statement1` will appear in the generated ha
2828

2929
### Conditions
3030

31-
The conditions in `If-Elif-Else` are comparisons, for example `a == 1` or `(a >= b) & (a <= c)`. Note that in this latter example, we used parentheses around each term. Each comparison, in essense, becomes a one-bit signal, and `&` is a _bit-wise operator_, not the logical `and`. When in doubt, just use parentheses.
31+
The conditions in `If-Elif-Else` are comparisons, for example `a == 1` or `(a >= b) & (a <= c)`. Note that in this latter example, we used parentheses around each term. Each comparison, in essence, becomes a one-bit signal, and `&` is a _bit-wise operator_, not the logical `and`. When in doubt, just use parentheses.
3232

3333
If you have a signal with more than one bit and use it as the condition, as in `with m.If(a):`, then the condition will be true if any bit in `a` is 1.
3434

6_combining.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ class BusLayout(Layout):
243243
def __init__(self):
244244
super().__init__([
245245
("data", unsigned(8)),
246-
("addr", unsigned(16))
246+
("addr", unsigned(16)),
247247
("wr", 1),
248248
("en", 1),
249249
])

0 commit comments

Comments
 (0)