Signal that the check on line 27 shouldn't be modified #276
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.
What does this PR do?
Adds a comment to signal to users that they shouldn't modify the code on line 27.
Motivation
Previously in our documentation we told users to add their API key in place of
<DATADOG_API_KEY>
. However, this string also appears in the check on line 27 and some users were modifying this as well causing the function not to complete properly. This comment will hopefully keep people from changing this line.Testing Guidelines
Additional Notes
Types of changes
Check all that apply