Skip to content

fix(docs): Fix docstring for enabled option #4052

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 11, 2021
Merged

fix(docs): Fix docstring for enabled option #4052

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d55c34b
fix docstring
lobsterkatie Oct 11, 2021
40d2ca6
Merge branch 'master' into kmclb-fix-sdk-enabled-docstring
lobsterkatie Oct 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions packages/types/src/options.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,8 @@ export interface Options {
debug?: boolean;

/**
* Specifies whether this SDK should activate and send events to Sentry.
* Disabling the SDK reduces all overhead from instrumentation, collecting
* breadcrumbs and capturing events. Defaults to true.
* Specifies whether this SDK should send events to Sentry.
* Defaults to true.
*/
enabled?: boolean;

Expand Down