Skip to content

docs: update quoter description #153

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

Merged
merged 1 commit into from
Aug 24, 2021
Merged

docs: update quoter description #153

merged 1 commit into from
Aug 24, 2021

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
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy