Skip to content

docs(api): add executable observer usage example - #490

Merged
roschaefer merged 1 commit into
mainfrom
docs/library-doctests
Nov 16, 2026
Merged

roschaefer merged 1 commit into
mainfrom
docs/library-doctests

Conversation

@roschaefer

@roschaefer roschaefer commented Nov 12, 2026 •

Copy link
Copy Markdown
Owner

Library callers need a checked example of configuring progress reporting without internal helpers. Add an executable public API example showing AfterPush handling and disabling the observer.

This example uses APIs already on main and can merge independently of the integration-test stack.

Validation: workspace tests including the new doctest, Clippy with warnings denied, formatting and diff checks pass.

@coderabbitai

coderabbitai Bot commented Nov 12, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 18 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 11423430-4f08-44ae-bbd2-2693eb7e3493
Commits

Reviewing files that changed from the base of the PR and between 69634de and d32e1aa.

Files selected for processing: 1

  • src/context.rs
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@roschaefer
roschaefer force-pushed the test/shared-scenario-fixtures branch from f3b3ca3 to 1189ba4 Compare November 16, 2026 16:24
@roschaefer
roschaefer force-pushed the docs/library-doctests branch from 8ea8e86 to 9899e9f Compare November 16, 2026 16:24
@roschaefer
roschaefer changed the base branch from test/shared-scenario-fixtures to main November 16, 2026 16:24
Library callers need a checked example of configuring progress reporting and clearing it without relying on internal test helpers.
@roschaefer
roschaefer force-pushed the docs/library-doctests branch from 9899e9f to d32e1aa Compare November 16, 2026 18:03
@roschaefer

Copy link
Copy Markdown
Owner Author

@codex review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 16, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-16T18:04:58.075451Z d32e1aa Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Another round soon, please!

Reviewed commit: d32e1aa237

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@roschaefer
roschaefer marked this pull request as ready for review November 16, 2026 18:08
@roschaefer
roschaefer enabled auto-merge (squash) November 16, 2026 18:08
@roschaefer
roschaefer merged commit a57311c into main Nov 16, 2026
13 checks passed
@roschaefer
roschaefer deleted the docs/library-doctests branch November 16, 2026 18:12
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