Skip to content

Commit

Permalink
Use MUST consistently instead of SHALL (open-telemetry#1208)
Browse files Browse the repository at this point in the history
* Use MUST consistently instead of shall.

* Update specification/trace/semantic_conventions/messaging.md

Co-authored-by: Christian Neumüller <[email protected]>

Co-authored-by: Christian Neumüller <[email protected]>
  • Loading branch information
Anuraag Agrawal and Oberon00 authored Nov 8, 2020
1 parent 1e0e22c commit 3c20170
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions specification/baggage/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ OPTIONAL parameters:
### Get baggage

To access the value for a name/value pair by a prior event, the Baggage API
SHALL provide a function that takes a context and a name as input, and returns a
MUST provide a function that takes a context and a name as input, and returns a
value. Returns the value associated with the given name, or null
if the given name is not present.

Expand All @@ -71,7 +71,7 @@ OPTIONAL parameters:

### Set baggage

To record the value for a name/value pair, the Baggage API SHALL provide a function which
To record the value for a name/value pair, the Baggage API MUST provide a function which
takes a context, a name, and a value as input. Returns a new `Context` which
contains a `Baggage` with the new value.

Expand All @@ -90,7 +90,7 @@ for a string with no semantic meaning. Left opaque to allow for future functiona

### Remove baggage

To delete a name/value pair, the Baggage API SHALL provide a function which takes a context
To delete a name/value pair, the Baggage API MUST provide a function which takes a context
and a name as input. Returns a new `Context` which no longer contains the selected name.

REQUIRED parameters:
Expand All @@ -103,7 +103,7 @@ OPTIONAL parameters:

### Clear

To avoid sending any name/value pairs to an untrusted process, the Baggage API SHALL provide
To avoid sending any name/value pairs to an untrusted process, the Baggage API MUST provide
a function to remove all baggage entries from a context. Returns a new `Context`
with no `Baggage`.

Expand Down
2 changes: 1 addition & 1 deletion specification/trace/semantic_conventions/messaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Often such destinations are unnamed or have an auto-generated name.

## Conventions

Given these definitions, the remainder of this section describes the semantic conventions that shall be followed for Spans describing interactions with messaging systems.
Given these definitions, the remainder of this section describes the semantic conventions for Spans describing interactions with messaging systems.

### Span name

Expand Down

0 comments on commit 3c20170

Please sign in to comment.