docs(init): Fix sentry_sdk.init type hint
#3283
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sl0thentr0py
approved these changes
Jul 12, 2024
szokeasaurusrex
force-pushed
the
szokeasaurusrex/fix-init-type-hint
branch
2 times, most recently
from
68e0c7e
to
2d594c7
Compare
The current type hint suggests that all the parameters can be passed as positional arguments, when this is not the case. Only the `dsn` can be passed as a positional argument; the rest must be passed as keyword arguments. This PR makes the type hint reflect the reality of what parameters can be passed to `sentry_sdk.init`.
szokeasaurusrex
force-pushed
the
szokeasaurusrex/fix-init-type-hint
branch
from
2d594c7
to
c97b2fb
Compare
szokeasaurusrex
commented
Jul 12, 2024
sl0thentr0py
approved these changes
Jul 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current type hint suggests that all the parameters can be passed as positional arguments, when this is not the case. Only the
dsncan be passed as a positional argument; the rest must be passed as keyword arguments.This PR makes the type hint reflect the reality of what parameters can be passed to
sentry_sdk.init.