Skip to content

Commit 94660eb

Browse files
authored
Use non-normative should in Javadocs (#8390)
1 parent e520164 commit 94660eb

9 files changed

Lines changed: 11 additions & 11 deletions

File tree

api/all/src/main/java/io/opentelemetry/api/common/AttributesBuilder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public interface AttributesBuilder {
4444
* <p>Simple attributes ({@link AttributeType#STRING}, {@link AttributeType#LONG}, {@link
4545
* AttributeType#DOUBLE}, {@link AttributeType#BOOLEAN}, {@link AttributeType#STRING_ARRAY},
4646
* {@link AttributeType#LONG_ARRAY}, {@link AttributeType#DOUBLE_ARRAY}, {@link
47-
* AttributeType#BOOLEAN_ARRAY}) SHOULD be used whenever possible. Instrumentations SHOULD assume
47+
* AttributeType#BOOLEAN_ARRAY}) should be used whenever possible. Instrumentations should assume
4848
* that backends do not index individual properties of complex attributes, that querying or
4949
* aggregating on such properties is inefficient and complicated, and that reporting complex
5050
* attributes carries higher performance overhead.

api/incubator/src/main/java/io/opentelemetry/api/incubator/common/ExtendedAttributeKey.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,8 @@ static ExtendedAttributeKey<ExtendedAttributes> extendedAttributesKey(String key
114114
* <p>Simple attributes ({@link ExtendedAttributeType#STRING}, {@link ExtendedAttributeType#LONG},
115115
* {@link ExtendedAttributeType#DOUBLE}, {@link ExtendedAttributeType#BOOLEAN}, {@link
116116
* ExtendedAttributeType#STRING_ARRAY}, {@link ExtendedAttributeType#LONG_ARRAY}, {@link
117-
* ExtendedAttributeType#DOUBLE_ARRAY}, {@link ExtendedAttributeType#BOOLEAN_ARRAY}) SHOULD be
118-
* used whenever possible. Instrumentations SHOULD assume that backends do not index individual
117+
* ExtendedAttributeType#DOUBLE_ARRAY}, {@link ExtendedAttributeType#BOOLEAN_ARRAY}) should be
118+
* used whenever possible. Instrumentations should assume that backends do not index individual
119119
* properties of complex attributes, that querying or aggregating on such properties is
120120
* inefficient and complicated, and that reporting complex attributes carries higher performance
121121
* overhead.

api/incubator/src/main/java/io/opentelemetry/api/incubator/common/ExtendedAttributesBuilder.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ default <T> ExtendedAttributesBuilder put(AttributeKey<T> key, T value) {
3838
* <p>Simple attributes ({@link ExtendedAttributeType#STRING}, {@link ExtendedAttributeType#LONG},
3939
* {@link ExtendedAttributeType#DOUBLE}, {@link ExtendedAttributeType#BOOLEAN}, {@link
4040
* ExtendedAttributeType#STRING_ARRAY}, {@link ExtendedAttributeType#LONG_ARRAY}, {@link
41-
* ExtendedAttributeType#DOUBLE_ARRAY}, {@link ExtendedAttributeType#BOOLEAN_ARRAY}) SHOULD be
42-
* used whenever possible. Instrumentations SHOULD assume that backends do not index individual
41+
* ExtendedAttributeType#DOUBLE_ARRAY}, {@link ExtendedAttributeType#BOOLEAN_ARRAY}) should be
42+
* used whenever possible. Instrumentations should assume that backends do not index individual
4343
* properties of complex attributes, that querying or aggregating on such properties is
4444
* inefficient and complicated, and that reporting complex attributes carries higher performance
4545
* overhead.

context/src/main/java/io/opentelemetry/context/Context.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ default Context with(ImplicitContextKeyed value) {
212212
* Scope#close()} automatically.
213213
*
214214
* <p>The default implementation of this method will store the {@link Context} in a {@link
215-
* ThreadLocal}. Kotlin coroutine users SHOULD NOT use this method as the {@link ThreadLocal} will
215+
* ThreadLocal}. Kotlin coroutine users should not use this method as the {@link ThreadLocal} will
216216
* not be properly synced across coroutine suspension and resumption. Instead, use {@code
217217
* withContext(context.asContextElement())} provided by the {@code opentelemetry-extension-kotlin}
218218
* library.

context/src/main/java/io/opentelemetry/context/ImplicitContextKeyed.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public interface ImplicitContextKeyed {
2323
* <p>This method is equivalent to {@code Context.current().with(value).makeCurrent()}.
2424
*
2525
* <p>The default implementation of this method will store the {@link ImplicitContextKeyed} in a
26-
* {@link ThreadLocal}. Kotlin coroutine users SHOULD NOT use this method as the {@link
26+
* {@link ThreadLocal}. Kotlin coroutine users should not use this method as the {@link
2727
* ThreadLocal} will not be properly synced across coroutine suspension and resumption. Instead,
2828
* use {@code withContext(value.asContextElement())} provided by the {@code
2929
* opentelemetry-extension-kotlin} library.

sdk/common/src/main/java/io/opentelemetry/sdk/resources/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
*
1414
* <p>Attribute keys, and attribute values MUST contain only printable ASCII (codes between 32 and
1515
* 126, inclusive) and less than 256 characters. Type and attribute keys MUST have a length greater
16-
* than zero. They SHOULD start with a domain name and separate hierarchies with / characters, e.g.
16+
* than zero. They should start with a domain name and separate hierarchies with / characters, e.g.
1717
* k8s.io/namespace/name.
1818
*/
1919
@ParametersAreNonnullByDefault

sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/export/MetricProducer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
* <p>Alternative {@link MetricProducer} implementations can be used to bridge aggregated metrics
2020
* from other frameworks, and are registered with {@link
2121
* SdkMeterProviderBuilder#registerMetricProducer(MetricProducer)}. NOTE: When possible, metrics
22-
* from other frameworks SHOULD be bridged using the metric API, normally with asynchronous
22+
* from other frameworks should be bridged using the metric API, normally with asynchronous
2323
* instruments which observe the aggregated state of the other framework. However, {@link
2424
* MetricProducer} exists to accommodate scenarios where the metric API is insufficient. It should
2525
* be used with caution as it requires the bridge to take a dependency on {@code

sdk/metrics/src/main/java/io/opentelemetry/sdk/metrics/internal/view/FilteredAttributes.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ private FilteredAttributes(Object[] sourceData, int hashcode, int size) {
4747
/**
4848
* Create a {@link FilteredAttributes} instance.
4949
*
50-
* @param source the source attributes, which SHOULD be based on the standard {@link
50+
* @param source the source attributes, which should be based on the standard {@link
5151
* ImmutableKeyValuePairs}. If not, the source will first be converted to the standard
5252
* implementation.
5353
* @param includedKeys the set of attribute keys to include in the output.

sdk/profiles/src/main/java/io/opentelemetry/sdk/profiles/data/ProfileData.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ default byte[] getProfileIdBytes() {
121121
/**
122122
* Returns the original payload, in a profiler-native format e.g. JFR. Optional. Default behavior
123123
* should be to not include the original payload. If the original payload is in pprof format, it
124-
* SHOULD not be included in this field.
124+
* should not be included in this field.
125125
*/
126126
ByteBuffer getOriginalPayload();
127127

0 commit comments

Comments
 (0)