docs: document null and undefined attribute values undefined behavior #1650
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
dyladan
requested review from
legendecas,
markwolff,
mayurkale22,
mwear,
naseemkullah,
obecny,
OlivierAlbertini and
vmarchaud
as code owners
Codecov Report
@@ Coverage Diff @@
## master #1650 +/- ##
==========================================
- Coverage 91.37% 91.35% -0.02%
==========================================
Files 165 165
Lines 5042 5042
Branches 1040 1040
==========================================
- Hits 4607 4606 -1
- Misses 435 436 +1
|
vmarchaud
approved these changes
Nov 4, 2020
mayurkale22
approved these changes
Nov 4, 2020
| @@ -47,14 +47,17 @@ export interface Span { | |||
| * Sets a single Attribute with the key and value passed as arguments. | |||
| * | |||
| * @param key the key for this attribute. | |||
| * @param value the value for this attribute. | |||
| * @param value the value for this attribute. Setting a value null or | |||
| * undefined is invalid and will result in undefined behavior. | |||
There was a problem hiding this comment.
Nit: could you indent this second line of the JSDoc by 4 spaces to make to be consistent with others, also to make visually clear that it's a continued line.
| */ | ||
| setAttribute(key: string, value?: AttributeValue): this; | ||
|
|
||
| /** | ||
| * Sets attributes to the span. | ||
| * | ||
| * @param attributes the attributes that will be added. | ||
| * null or undefined attribute values |
mwear
approved these changes
Nov 5, 2020
obecny
approved these changes
Nov 6, 2020
dyladan
added a commit
to dyladan/opentelemetry-js
that referenced
this pull request
Sep 9, 2022
dyladan
added a commit
to dyladan/opentelemetry-js
that referenced
this pull request
Sep 9, 2022
pichlermarc
pushed a commit
to dynatrace-oss-contrib/opentelemetry-js
that referenced
this pull request
Dec 15, 2023
Co-authored-by: Amir Blum <amirgiraffe@gmail.com>
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.
Fixes #1614