Suggesting updates on the doc of DSChiefApprovals.etch
- Dominant language
- Solidity
- Stars
- 29
- Forks
- 45
- PR merge metrics
- No merged PRs in 30d
Description
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.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the README entries for DSChiefApprovals.etch and DSChiefApprovals.vote, then compare them with the linked src/chief.sol lines 79 and 86. Update both descriptions to document the emitted Etch event, and confirm the README accurately reflects those functions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- solidity
- Domain
- blockchain
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100