-
Notifications
You must be signed in to change notification settings - Fork 2
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
Add sort argument to get_markets #22
Conversation
WalkthroughThe update introduces a Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review Status
Actionable comments generated: 1
Configuration used: CodeRabbit UI
Files selected for processing (1)
- prediction_market_agent_tooling/benchmark/utils.py (2 hunks)
Additional comments: 3
prediction_market_agent_tooling/benchmark/utils.py (3)
- 25-27: The
MarketSort
enum is well-defined with clear, concise values (liquidity
andnewest
). This design choice aligns with the PR objectives and provides a structured way to specify sorting criteria.- 313-313: The addition of the
sort
parameter to theget_markets
function is a significant enhancement. It's good to see that it can accept bothMarketSort
andNone
, with a sensible default toliquidity
when not provided. This change improves the function's flexibility and usability.- 318-321: The implementation of sorting logic within the
get_manifold_markets_paged
function call is correctly handling thesort
parameter. By defaulting toliquidity
whensort
isNone
, it ensures backward compatibility and adheres to the new sorting feature's requirements.
if sort is not None: | ||
raise ValueError(f"Polymarket doesn't support sorting.") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Raising a ValueError
when a sort is attempted on Polymarket data is a necessary limitation given the current API constraints. However, it's important to ensure that this limitation is clearly documented in the function's docstring or in relevant user-facing documentation to prevent confusion.
Consider adding a note in the function's docstring about the limitation regarding sorting with Polymarket sources to improve clarity for users.
Summary by CodeRabbit