Conversation
There was a problem hiding this comment.
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
_documentationmodule fromrecoverable. - Add
_documentation::recipeswith multiple doctest-style examples covering recovery propagation and heuristics. - Add
_documentationmodule 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.
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
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.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
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.
improving the docs with some additional knowledge