enhancements(API reference): Indicate deprecated func clearly in the menu #3127
+5
−5
Conversation
This file contains hidden or 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 latest updates on your projects. Learn more about Vercel for GitHub.
6 Skipped Deployments
|
nidhi-singh02
commented
Oct 14, 2025
| **This function may return a price from arbitrarily far in the past.** It is the | ||
| caller's responsibility to check the returned \`publishTime\` to ensure that the | ||
| update is recent enough for their use case. If you need the latest price, update the price using [\`updatePriceFeeds()\`](updatePriceFeeds) and then call [\`getPrice()\`](getPrice). | ||
| update is recent enough for their use case. If you need the latest price, update the price using [\`updatePriceFeeds()\`](updatePriceFeeds) and then call [\`getPriceNoOlderThan()\`](getPriceNoOlderThan). |
There was a problem hiding this comment.
calling the correct method.
nidhi-singh02
commented
Oct 14, 2025
| Use this function if you want to use a Pyth price for a fixed time and not the most | ||
| recent price; otherwise, consider using [updatePriceFeeds](update-price-feeds) | ||
| followed by [getPrice](get-price) or one of its variants. | ||
| followed by [getPriceNoOlderThan](get-price-no-older-than) or one of its variants. |
There was a problem hiding this comment.
calling the correct method.
aditya520
reviewed
Oct 14, 2025
| name, | ||
| href: `/price-feeds/${chain}/${name}`, | ||
| Object.entries(methods).map(([methodKey, methodValue]) => ({ | ||
| name: (methodValue as { name: string }).name, |
There was a problem hiding this comment.
We want to show the exact method name in the menu as when you open a method (which includes deprecated) so modifying the name parameter.
I have attached the screenshot in the PR description to show how the menu will look with this changeset.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
The menu does not show if the method is deprecated, indicating it clearly so users allows at a glance. This will enhance the developer experience.
Rationale
How has this been tested?