Update docs for SafeERC20.forceApprove
#4231
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I was reading the release notes of v4.9.0-rc.0, when I saw this PR mentioned:
#4067
This, in turn, led me to this PR:
#3851
I read all the comments there, but I was still unsure what the goal of
forceApprove
is. Then, I looked at USDT's source code, and it all became clear to me.This PR rewrites the NatSpec of
SafeERC20.forceApprove
to mention USDT since Tether is the primary use case for this function.