docs: fix comments for swap functions #7951
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The comments imply that all paths besides the first 2 will be ignored.
gui1117
reviewed
Mar 18, 2025
| @@ -725,14 +725,14 @@ pub mod pallet { | |||
| } | |||
|
|
|||
| impl<T: Config> Pallet<T> { | |||
| /// Swap exactly `amount_in` of asset `path[0]` for asset `path[1]`. | |||
| /// Swap exactly `amount_in` of asset `path[0]` for asset `path[last]`. | |||
There was a problem hiding this comment.
I think we should precise that it swaps 0 with 1 then 1 with 2 until last no?
but I don't know how to phrase it.
There was a problem hiding this comment.
This is consistent with the comment for do_swap_exact_credit_tokens_for_tokens, I can change both if you think that's better of course.
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The comments imply that all paths besides the first 2 will be ignored.