Skip to content

Conversation

@ekzhang
Copy link
Contributor

@ekzhang ekzhang commented Aug 12, 2021

Hi, thanks for this library to interact with Uniswap V3 protocol. I found it very helpful as an example.

I noticed that some of the documentation for the get_price_input and get_price_output functions was a little bit unclear, causing some confusion about which of token0 or token1 was the input or output token.

We stubbed our toe on this, especially the phrasing "the amount of the input token you get for qty of the output token" - which is using the words "input" and "output" opposite from how they are typically used.

This PR clarifies the documentation of those methods.

@ErikBjare ErikBjare changed the title docs: update quoter description in Uniswap.py docs: update quoter description Aug 24, 2021
@ErikBjare ErikBjare merged commit 47a0414 into uniswap-python:master Aug 24, 2021
@ErikBjare
Copy link
Member

Thank you for contributing! ❤️

@ekzhang ekzhang deleted the patch-1 branch August 24, 2021 14:21
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

Successfully merging this pull request may close these issues.

2 participants