Skip to content
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

docs: document null and undefined attribute values undefined behavior #1650

Merged
merged 3 commits into from
Nov 11, 2020

Conversation

dyladan
Copy link
Member

@dyladan dyladan commented Nov 4, 2020

Fixes #1614

@codecov
Copy link

codecov bot commented Nov 4, 2020

Codecov Report

Merging #1650 (1573820) into master (894c8d8) will decrease coverage by 0.01%.
The diff coverage is n/a.

@@            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     
Impacted Files Coverage Δ
...emetry-core/src/platform/node/RandomIdGenerator.ts 87.50% <0.00%> (-6.25%) ⬇️

@@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

@dyladan dyladan merged commit e78f65e into open-telemetry:master Nov 11, 2020
@dyladan dyladan added the document Documentation-related label Nov 11, 2020
@Flarna Flarna deleted the undefined-null branch November 30, 2020 11:38
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
document Documentation-related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Spec: Document null values as invalid for Attributes
5 participants