clean up beforeSend's docstring

lobsterkatie · lobsterkatie · commit 6ae6b3a5f5a1 · 2022-11-03T14:06:57.000-07:00
diff --git a/packages/types/src/options.ts b/packages/types/src/options.ts
@@ -195,15 +195,14 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
   tracesSampler?: (samplingContext: SamplingContext) => number | boolean;
 
   /**
-   * A callback invoked during event submission, allowing to optionally modify
-   * the event before it is sent to Sentry.
+   * An event-processing callback for error and message events, guaranteed to be invoked after all other event
+   * processors, which allows an event to be modified or dropped.
    *
-   * Note that you must return a valid event from this callback. If you do not
-   * wish to modify the event, simply return it at the end.
-   * Returning null will cause the event to be dropped.
+   * Note that you must return a valid event from this callback. If you do not wish to modify the event, simply return
+   * it at the end. Returning `null` will cause the event to be dropped.
    *
    * @param event The error or message event generated by the SDK.
-   * @param hint May contain additional information about the original exception.
+   * @param hint Event metadata useful for processing.
    * @returns A new event that will be sent | null.
    */
   beforeSend?: (event: Event, hint: EventHint) => PromiseLike<Event | null> | Event | null;
