Skip to content

ref(api): Type hinting for start_transaction kwargs #2787

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.

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

Closed

Conversation

szokeasaurusrex
Copy link
Member

This PR adds be type hints for the **kwargs that can be passed to sentry_sdk.start_transaction, thereby clearly documenting the parameters that can be passed directly in the code.

Ref getsentry/sentry-docs#5082

  • We intend to add to the docs page at least the most useful arguments defined in the TransactionKwargs type that this PR introduces.

@szokeasaurusrex szokeasaurusrex self-assigned this Mar 5, 2024
@szokeasaurusrex szokeasaurusrex marked this pull request as draft March 5, 2024 13:35
@szokeasaurusrex
Copy link
Member Author

Need to fix syntax errors. Class TypedDict syntax is not supported in old Pythons!

@szokeasaurusrex
Copy link
Member Author

Closed in favor of #2796, which applies these changes on the 2.0 branch (getting TypedDict to work in the way I would like it to here would be extremely difficult below Python 3.6)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant