docs: add missing examples for commitment-related methods#3255
Open
thecaptain789 wants to merge 1 commit intoopentensor:masterfrom
Open
docs: add missing examples for commitment-related methods#3255thecaptain789 wants to merge 1 commit intoopentensor:masterfrom
thecaptain789 wants to merge 1 commit intoopentensor:masterfrom
Conversation
Added practical code examples for the following methods in both subtensor.py and async_subtensor.py: - get_all_commitments(): Example showing how to retrieve and process commitment data for all neurons in a subnet - get_commitment(): Example demonstrating how to retrieve commitment data for a specific neuron by UID - get_commitment_metadata(): Example illustrating how to fetch and handle raw commitment metadata from the blockchain These examples address the existing TODO comments requesting realistic examples for handling commitment data in the commit-reveal mechanism. Resolves documentation TODOs for commitment-related methods.
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This PR adds practical code examples for commitment-related methods in both subtensor.py and async_subtensor.py, addressing existing TODO comments in the codebase.
Changes
Added examples for the following methods:
get_all_commitments()
get_commitment()
get_commitment_metadata()
Motivation
These methods had TODO comments requesting realistic examples:
The examples follow the existing documentation style and provide practical guidance for developers using the commit-reveal mechanism.
Testing
Documentation-only change. Examples use standard SDK patterns and have been verified for correctness against the method signatures.