Skip to content

feat(recoverable): add recipes docs#381

Open
martintmk wants to merge 8 commits intomainfrom
recoverable-docs
Open

feat(recoverable): add recipes docs#381
martintmk wants to merge 8 commits intomainfrom
recoverable-docs

Conversation

@martintmk
Copy link
Copy Markdown
Member

@martintmk martintmk commented Apr 16, 2026

improving the docs with some additional knowledge

Copilot AI review requested due to automatic review settings April 16, 2026 14:23
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds longer-form “recipes” documentation to the recoverable crate, following the workspace pattern of exposing cookbook-style docs under a _documentation module.

Changes:

  • Export a new public _documentation module from recoverable.
  • Add _documentation::recipes with multiple doctest-style examples covering recovery propagation and heuristics.
  • Add _documentation module root (mod.rs) to organize longer-form docs.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
crates/recoverable/src/lib.rs Exposes the new _documentation module from the crate root.
crates/recoverable/src/_documentation/mod.rs Introduces the longer-form documentation module and wires in recipes.
crates/recoverable/src/_documentation/recipes.rs Adds “recipes” documentation with practical examples/doctests for Recovery usage.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread crates/recoverable/src/_documentation/recipes.rs Outdated
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.0%. Comparing base (667e12a) to head (9196da5).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #381   +/-   ##
=======================================
  Coverage   100.0%   100.0%           
=======================================
  Files         224      224           
  Lines       16187    16187           
=======================================
  Hits        16187    16187           

☔ 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.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 16, 2026 14:29
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread crates/recoverable/src/_documentation/recipes.rs Outdated
Comment thread crates/recoverable/src/_documentation/recipes.rs Outdated
Copilot AI review requested due to automatic review settings April 22, 2026 13:14
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

3 participants