From 8e2a784b8e3e7c8c51207f666fe50e2616f53e6a Mon Sep 17 00:00:00 2001 From: Carl Meyer Date: Mon, 29 Jul 2024 09:15:47 -0700 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Niko Matsakis --- book/src/cycles/fallback.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/book/src/cycles/fallback.md b/book/src/cycles/fallback.md index e2d821a..2509017 100644 --- a/book/src/cycles/fallback.md +++ b/book/src/cycles/fallback.md @@ -4,13 +4,15 @@ Panicking when a cycle occurs is ok for situations where you believe a cycle is To use cycle recovery, you annotate potential participants in the cycle with the `recovery_fn` argument to `#[salsa::tracked]`, e.g. `#[salsa::tracked(recovery_fn=my_recovery_fn)]`. When a cycle occurs, if any participant P has recovery information, then no panic occurs. Instead, the execution of P is aborted and P will execute the recovery function to generate its result. Participants in the cycle that do not have recovery information continue executing as normal, using this recovery result. -The recovery function has a similar signature to a query function. It is given a reference to your database along with a `salsa::Cycle` describing the cycle that occurred and the input ingredient to the query that caused the cycle; it returns the result of the query. Example: +The recovery function has a similar signature to a query function. It is given a reference to your database along with a `salsa::Cycle` describing the cycle that occurred and the arguments to the tracked function that caused the cycle; it returns the result of the query. Example: ```rust fn my_recover_fn( db: &dyn MyDatabase, cycle: &salsa::Cycle, - input: MyIngredient, + arg1: T1, + ... + argN: TN, ) -> MyResultValue ```