Skip to content

chore: improve code comments clarity#326

Open
stringsbuilder wants to merge 1 commit intoPolymarket:mainfrom
stringsbuilder:main
Open

chore: improve code comments clarity#326
stringsbuilder wants to merge 1 commit intoPolymarket:mainfrom
stringsbuilder:main

Conversation

@stringsbuilder
Copy link
Copy Markdown

@stringsbuilder stringsbuilder commented Apr 9, 2026

improve code comments clarity


Note

Low Risk
Comment-only changes in order_builder and 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_u128 and 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.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.54%. Comparing base (77264a4) to head (5abf64d).

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           
Flag Coverage Δ
rust 85.54% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant