clash-lang / clash-compiler

Haskell to VHDL/Verilog/SystemVerilog compiler
https://clash-lang.org/
Other
1.4k stars 149 forks source link

Clarify `BitPack` is not for creating custom encodings #2575

Closed DigitalBrains1 closed 10 months ago

DigitalBrains1 commented 10 months ago

It's easy to misconstrue the purpose of BitPack

Still TODO:

DigitalBrains1 commented 10 months ago
  • Rather than dictate what the bit representation in HDL is, a BitPack instance needs to exactly match that bit representation.

    I also got confused by that sentence, probably because its not immediately clear what "that bit representation" refers to.

I hoped it was clear that "that representation" in the second sentence fragment refers to "the representation" in the first sentence fragment, but would you rather see it repeated verbatim?

Rather than dictate what the bit representation in HDL is, a BitPack instance needs to exactly match the bit representation in HDL.

kleinreact commented 10 months ago

Rather than dictate what the bit representation in HDL is, a BitPack instance needs to exactly match the bit representation in HDL.

It still confuses me. Maybe, because "the bit representation" is just very generic: so maybe elaborating on what bit representation is meant? I mean: I get what you wanna say with the sentence, but I have to read it at least twice and need to parse it carfully to get the meaning.

DigitalBrains1 commented 10 months ago

I'll rephrase entirely.

DigitalBrains1 commented 10 months ago

@mergify rebase

mergify[bot] commented 10 months ago

rebase

❌ Unable to rebase: user DigitalBrains1 is unknown.

Please make sure `DigitalBrains1` has logged in Mergify dashboard.