docs: Move transaction __init__ doc comment content#2918
Merged
szokeasaurusrex merged 2 commits intoMar 28, 2024
Conversation
antonpirker
approved these changes
Mar 28, 2024
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This change moves the
Transactionconstructor's parameter doctsring from the__init__method to the class's docstring. This way, the API docs display the parameter descriptions under the class. When the docstring is defined on__init__, the parameter descriptions are missing from the API docs.This change also documents the
kwargsparameter in the API docs.Before the change:
After the change:
Partially addresses getsentry/sentry-docs#5082