Small APIdocs improvement #2828
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
antonpirker
commented
Mar 18, 2024
szokeasaurusrex
approved these changes
Mar 18, 2024
|
|
||
| :param value: The level to set. | ||
| """ | ||
| logger.warning( |
There was a problem hiding this comment.
@antonpirker Why are you emitting the warning with logger? When I have had to emit deprecation warnings, I usually do so as follows:
warnings.warn("blah blah blah", DeprecationWarning, stacklevel=2)Is there any significant difference with using logger.warning vs warnings.warn? Do we have a preference in the SDKs?
There was a problem hiding this comment.
Just used it because all the other deprecation warnings in that file do it the same way.
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.
This PR makes sure all apidocs are recreated always (by deleting an eventually existing
docs/_buildfolder) and also adds some minor changes toset_levelandset_tagto make the types of parameters clear.This is related to this Docs PR: getsentry/sentry-docs#5432