From 5343bcccf963f392ed651d030db98ef2650a8503 Mon Sep 17 00:00:00 2001 From: Wessel Loth Date: Fri, 7 Jun 2019 11:43:55 +0200 Subject: [PATCH] Add more detailed explanation on beforeBreadcrumb function --- .../_documentation/error-reporting/configuration/index.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/collections/_documentation/error-reporting/configuration/index.md b/src/collections/_documentation/error-reporting/configuration/index.md index 078eb2d98c50d..9c128332ea80f 100644 --- a/src/collections/_documentation/error-reporting/configuration/index.md +++ b/src/collections/_documentation/error-reporting/configuration/index.md @@ -195,9 +195,10 @@ sending. ### `before-breadcrumb` This function is called with an SDK specific breadcrumb object before the breadcrumb is added to the -scope. When nothing is returned from the function the breadcrumb is dropped. The callback typically -gets a second argument (called a "hint") which contains the original object that the breadcrumb was -created from to further customize what the breadcrumb should look like. +scope. When nothing is returned from the function, the breadcrumb is dropped. To pass the +breadcrumb through, simply return the first argument, which contains the breadcrumb object. +The callback typically gets a second argument (called a "hint") which contains the original object +that the breadcrumb was created from to further customize what the breadcrumb should look like. ## Transport Options