solang icon indicating copy to clipboard operation
solang copied to clipboard

Add codegen CFG expression documentation

Open xermicus opened this issue 3 years ago • 1 comments

Working with our CFG Expressions is not very intuitive ATM. Individual Expression variants deserve comments to provide a bit of context, e.g. describing their fields and maybe other things to be aware of. It could also help to use named fields instead.

On the other hand, Instr is much easier to work with and might serve as a role model.

xermicus avatar Nov 17 '22 14:11 xermicus

Hi @jporwal05

Meanwhile, the CFG Expressions were already refactored to use named fields on the Enum variants. Which leaves only some comments, which should be straight forward to distill based on the field names. You're very welcome to open a PR adding and improving doc-comments any time.

In case you have questions feel free to ask on #solang-contributors on the HL discord

xermicus avatar Sep 05 '23 13:09 xermicus