Trick or Treat

First Flight #27
Beginner FriendlyFoundry
100 EXP
View results
Submission Details
Severity: low
Invalid

Inaccurate Documentation Reference in trickOrTreat Function

Description

The trickOrTreat function currently references a non-existent function fellForTrick() in its comments in line 91, stating: User needs to call fellForTrick() to finish the transaction. However, the correct function that users need to call is actually resolveTrick().

Impact

This inconsistency could lead to confusion for developers and users who rely on the code comments to understand transaction flows. Misleading documentation could cause users to overlook the resolveTrick function and fail to complete the transaction correctly, potentially resulting in failed interactions with the contract, or developers might have to spend time debugging issues that could have been avoided with accurate documentation.

Recommended Mitigation

Update the comment to reference resolveTrick() instead of fellForTrick():

// User needs to call resolveTrick() to finish the transaction
Updates

Appeal created

bube Lead Judge about 1 year ago
Submission Judgement Published
Invalidated
Reason: Non-acceptable severity
Assigned finding tags:

[invalid] Wrong comment

This is an informational issue.

Support

FAQs

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