This repository was archived by the owner on May 25, 2026. It is now read-only.
docs: clarify redemption/settlement scope in README#296
Open
jasonandjay wants to merge 1 commit into
Open
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
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.
Related to #295
Summary
py-clob-clientcurrently focuses on CLOB trading APIs (orders/books/trades/balances).This should reduce confusion for users expecting redemption via this client package.
Note
Low Risk
Low risk: documentation-only change that clarifies SDK scope and points users to external settlement workflows; no runtime behavior is affected.
Overview
Adds a new README section, "Redeeming resolved positions (important)", clarifying that
py-clob-clientcurrently covers only CLOB trading APIs and does not provide an SDK helper for redeeming/settling resolved positions, directing users to the official Polymarket app/workflow or other settlement docs/tools.Written by Cursor Bugbot for commit b5d0ece. This will update automatically on new commits. Configure here.