amaranth icon indicating copy to clipboard operation
amaranth copied to clipboard

Clarify documentation on the module usage in `wiring.connect()`

Open 5aji opened this issue 1 year ago • 1 comments

The first argument to connect() is the module that the connections should be added to, but the documentation doesn't state this clearly. It becomes clear once you understand it (the connections must be added to something, and the documentation shows it later) but it tripped me up since I was mentally primed to other constructs that operate on a Module directly (If, FSM, .next etc).

https://github.com/amaranth-lang/amaranth/blob/f20f04277225fe714054472e3d6daf930a9b12ef/amaranth/lib/wiring.py#L1358-L1402

5aji avatar Sep 10 '24 19:09 5aji