Add comments for clients#468
Merged
Yang-33 merged 4 commits intoline:masterfrom Apr 7, 2025
Merged
Conversation
Yang-33
force-pushed
the
comment-for-client
branch
from
583894b to
c81b2a6
Compare
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
2 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.
This change adds comments for sdk users in code related to the client.
(1) The internal HTTP client is exposed, but this change adds caution against using it. If a breaking change is made to this, the version will be raised, ignoring semver.
(2) For the user-facing HTTP client, this change adds comments with examples using YARD.
Comments on the class methods will be improved in a separate PR.