Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

LendingPool.swapBorrowRateMode natspec documentation for the rateMode parameter is misleading #330

Open
StErMi opened this issue Sep 14, 2023 · 1 comment

Comments

@StErMi
Copy link

StErMi commented Sep 14, 2023

The current natspec documentation for the rateMode parameter on the LendingPool.swapBorrowRateMode functions states

@param rateMode The rate mode that the user wants to swap to

From a user prospective, it seems that you should pass the rateMode that you want to switch your debt INTO
Instead, the function requires you to pass the CURRENT rateMode that you are using for your debt position.

Honestly, I think that the best UX would be to specify the rateMode you would like to swap to, but changing the natspec is much less complex than changing the whole logic of the function.

@SimkoCarlos
Copy link

+1 I just noticed this too

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants