ds-chief icon indicating copy to clipboard operation
ds-chief copied to clipboard

Suggesting updates on the doc of DSChiefApprovals.etch

Open DocCon-team opened this issue 2 years ago • 0 comments

Hi,

The function DSChiefApprovals.etch emits an event Etch, which is not documented in the README doc.

https://github.com/dapphub/ds-chief/blob/4a833cdaeb66313da0fb16108771a52135d23a04/src/chief.sol#L79

A potential fix could be adding the description "Emits an Etch event" to the README doc.

Furthermore, function DSChiefApprovals.vote calls the etch function. So it emits the Etch event as well.

https://github.com/dapphub/ds-chief/blob/4a833cdaeb66313da0fb16108771a52135d23a04/src/chief.sol#L86

A potential fix could also be adding the description "Emits an Etch event" to this function in the README doc.

Could you please check it?

Thanks.

DocCon-team avatar May 15 '22 18:05 DocCon-team