Beginner FriendlyFoundry
100 EXP
View results
Submission Details
Severity: low
Invalid

Wrong Natspec documentation

Summary

Wrong NatSpec Documentation in getPassword Function

Vulnerability Details

The NatSpec documentation for the getPassword function incorrectly states that it expects a parameter (newPassword). This discrepancy between the documentation and the actual function signature could lead to confusion for developers and users of the contract. It's important to ensure that NatSpec documentation accurately reflects the function's parameters to avoid misunderstandings.

Impact

It won't pose any risk to working of contract. But it will lead to developer misunderstandings and long-term maintenance of codebase.

Tools Used

Manual Review

Recommendations

Update the NatSpec documentation for the getPassword function to accurately reflect its working.

- * @param newPassword The new password to set.
+ * @return The stored password.
Updates

Lead Judging Commences

inallhonesty Lead Judge
about 2 years ago
inallhonesty Lead Judge about 2 years ago
Submission Judgement Published
Invalidated
Reason: Non-acceptable severity

Support

FAQs

Can't find an answer? Chat with us on Discord, Twitter or Linkedin.