WebAssembly / WASI

WebAssembly System Interface
Other
4.85k stars 251 forks source link

Confusing formatting for bit flags #468

Open codefromthecrypt opened 2 years ago

codefromthecrypt commented 2 years ago

While this looks fine in ASCII, the markdown rendering of bitflags confusingly places the flag number at the outer indent, for example drawing confusion as to whether the first is not a flag.

Screen Shot 2022-02-10 at 11 15 59 AM

This confusion is easy if you don't click around to see what Record means (Rights was retyped from saying rights: Flags(u64) to rights: Record) or scroll to the bottom to notice all the items have an outdented bit number.

I think choosing another way to indicate the bit number that doesn't look weird in GitHub rich view will eliminate this.

codefromthecrypt commented 2 years ago

another way, and I expect this to be turned down, but Flags(u64) was really direct vs naming things Record and figuring out later it is just a bit flag