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

Fix typo and improve grammar Update README.md #42

Merged
merged 1 commit into from
Jan 15, 2025

Conversation

defitricks
Copy link
Contributor

Problem

The description of the explainTokenPrice method contains a typo and unclear phrasing:

"Get a list of tokens and pool how price for calculated."

This sentence has grammatical issues and lacks clarity due to word agreement errors and missing elements.

Solution

The corrected version of the sentence is:
"Get a list of tokens and pools explaining how the price is calculated."

This revision resolves the grammatical inconsistency and improves the overall readability of the documentation, ensuring that users can clearly understand the method's purpose.

Why this fix is important

  • Improved clarity: Documentation is a key reference for developers, and unclear or incorrect descriptions can lead to confusion, incorrect usage, or misinterpretation of the API.
  • Professionalism: High-quality documentation reflects the professionalism of the library and enhances its credibility in the developer community.
  • Ease of use: Clear instructions reduce the time developers spend trying to understand the API, contributing to a better user experience.

Thank you for reviewing this PR! Let me know if there are any additional changes needed. 😊

The description of the explainTokenPrice method contains a typo and unclear phrasing:

"Get a list of tokens and pool how price for calculated."
@jovfer jovfer merged commit 39d6fcf into Ankr-network:main Jan 15, 2025
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