Skip to content

docs: cleanup clob docs/commands#295

Open
ethdew19 wants to merge 1 commit intoPolymarket:mainfrom
ethdew19:update-docs
Open

docs: cleanup clob docs/commands#295
ethdew19 wants to merge 1 commit intoPolymarket:mainfrom
ethdew19:update-docs

Conversation

@ethdew19
Copy link
Copy Markdown
Contributor

@ethdew19 ethdew19 commented Mar 20, 2026

Add clob feature flag to example run commands, and update docs to reflect that it's behind a feature flag now.


Note

Low Risk
Low risk documentation-only changes that update example run commands and module docs to match feature gating; no runtime logic is modified.

Overview
Updates all CLOB examples’ cargo run commands to include the clob feature (including WS and heartbeats variants) so they match the examples’ required-features.

Adjusts src/clob/mod.rs docs to state the module is behind the clob feature flag and trims the optional-features list accordingly.

Written by Cursor Bugbot for commit 1895bb3. This will update automatically on new commits. Configure here.

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 20, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.45%. Comparing base (8c98bb8) to head (1895bb3).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #295   +/-   ##
=======================================
  Coverage   85.45%   85.45%           
=======================================
  Files          32       32           
  Lines        5121     5121           
=======================================
  Hits         4376     4376           
  Misses        745      745           
Flag Coverage Δ
rust 85.45% <ø> (ø)

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