chore: improve code comments clarity#326
Open
stringsbuilder wants to merge 1 commit intoPolymarket:mainfrom
Open
chore: improve code comments clarity#326stringsbuilder wants to merge 1 commit intoPolymarket:mainfrom
stringsbuilder wants to merge 1 commit intoPolymarket:mainfrom
Conversation
Signed-off-by: stringsbuilder <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #326 +/- ##
=======================================
Coverage 85.54% 85.54%
=======================================
Files 32 32
Lines 5167 5167
=======================================
Hits 4420 4420
Misses 747 747
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
improve code comments clarity
Note
Low Risk
Comment-only changes in
order_builderand WebSocket client docs; no runtime behavior or API changes, so risk is minimal.Overview
Improves documentation clarity by fixing typos/grammar in Rust doc comments.
Updates wording in
to_fixed_u128and several WebSocket subscription/unsubscribe method docs (e.g., “tick size changes”, “server unsubscribe request”) without changing any logic.Reviewed by Cursor Bugbot for commit 5abf64d. Bugbot is set up for automated code reviews on this repo. Configure here.