aave / protocol-v2

Aave Protocol V2
https://aave.com
Other
658 stars 744 forks source link

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

Open StErMi opened 12 months ago

StErMi commented 12 months ago

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 commented 10 months ago

+1 I just noticed this too