From 0497c068be085f0ba65075fcacc5b443204d8b41 Mon Sep 17 00:00:00 2001 From: Eduardo Blancas Date: Tue, 24 Oct 2023 17:27:10 -0600 Subject: [PATCH] fix docs --- doc/telemetry.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/telemetry.md b/doc/telemetry.md index b62bd52..7a3e897 100644 --- a/doc/telemetry.md +++ b/doc/telemetry.md @@ -75,7 +75,7 @@ For more details, see the [API Reference](api/telemetry). +++ -To unit test decorated functions, call the function and check `__wrapped__._telemetry_started` attribute. If it exists, it means the function has been decorated with `@log_call()`, you can use it to verify what's logged: +To unit test decorated functions, call the function and check `__wrapped__._telemetry_success` attribute. If it exists, it means the function has been decorated with `@log_call()`, you can use it to verify what's logged: ```{code-cell} ipython3 @telemetry.log_call(log_args=True, ignore_args=("y",)) @@ -89,7 +89,7 @@ _ = divide(2, 4) ```{code-cell} ipython3 from unittest.mock import ANY -assert divide.__wrapped__._telemetry_started == { +assert divide.__wrapped__._telemetry_success == { "action": "ploomber-core-divide-started", "metadata": { "argv": ANY, @@ -98,7 +98,7 @@ assert divide.__wrapped__._telemetry_started == { } ``` -`__wrapped__._telemetry_started` will keep the latest logged data, so you must call it at least one; otherwise, it'll be `None`. +`__wrapped__._telemetry_success` will keep the latest logged data, so you must call it at least one; otherwise, it'll be `None`. +++