Inconsistency between the code and the API doc of DSChiefApprovals.lock and DSChiefApprovals.free
- Dominant language
- Solidity
- Stars
- 29
- Forks
- 45
- PR merge metrics
- No merged PRs in 30d
Description
Hi,
In the APIs doc in README.md, it is stated that the functions `DSChiefApprovals.lock` and `DSChiefApprovals.free` fire a `LogLockFree` event. However, their corresponding code does not emit such an event actually.
https://github.com/dapphub/ds-chief/blob/4a833cdaeb66313da0fb16108771a52135d23a04/README.md?plain=1#L105
https://github.com/dapphub/ds-chief/blob/4a833cdaeb66313da0fb16108771a52135d23a04/README.md?plain=1#L112
A potential fix could be removing the "Fires a `LogLockFree` event" sentence from README.md.
Could you please check it?
Thanks.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start in README.md at the API entries for DSChiefApprovals.lock and DSChiefApprovals.free, then compare those claims with the corresponding contract code. Confirm whether either function emits LogLockFree and ensure the documentation accurately describes the behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- solidity
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100