Skip to content

Commit c4bda70

Browse files
authored
Fix doc typo (#478)
1 parent f048b89 commit c4bda70

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

instrumentation/opentelemetry_bandit/lib/opentelemetry_bandit.ex

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ defmodule OpentelemetryBandit do
3434
default: [],
3535
type_spec: quote(do: opt_in_attrs()),
3636
doc: """
37-
Use semantic conventions library to ensure compatability, e.g. `[HTTPAttributes.http_request_body_size()]`
37+
Use semantic conventions library to ensure compatibility, e.g. `[HTTPAttributes.http_request_body_size()]`
3838
3939
#{Enum.map_join(opt_ins, "\n\n", &" * `#{inspect(&1)}`")}
4040
"""
@@ -93,7 +93,7 @@ defmodule OpentelemetryBandit do
9393
]
9494
)
9595

96-
@typedoc "Use semantic conventions library to ensure compatability, e.g. `HTTPAttributes.http_request_body_size()`"
96+
@typedoc "Use semantic conventions library to ensure compatibility, e.g. `HTTPAttributes.http_request_body_size()`"
9797
@type opt_in_attr() ::
9898
unquote(ClientAttributes.client_port())
9999
| unquote(HTTPAttributes.http_request_body_size())
@@ -119,7 +119,7 @@ defmodule OpentelemetryBandit do
119119
### Opt-in Semantic Convention Attributes
120120
121121
Otel SemConv requires users to explicitly opt in for any attribute with a
122-
requirement level of `opt-in`. To ensure compatability, always use the
122+
requirement level of `opt-in`. To ensure compatibility, always use the
123123
SemConv attribute.
124124
125125
Example:

instrumentation/opentelemetry_cowboy/src/opentelemetry_cowboy.erl

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Supported opt-in attributes can be configured using the `opt_in_attrs` option.
3939
### Opt-in Semantic Convention Attributes
4040
4141
Otel SemConv requires users to explicitly opt in for any attribute with a
42-
requirement level of `opt-in`. To ensure compatability, always use the
42+
requirement level of `opt-in`. To ensure compatibility, always use the
4343
SemConv attribute.
4444
4545
Example:
@@ -105,7 +105,7 @@ Supported options:
105105
* `client_address_headers` - Headers to use for extracting original client request address info. Default: `[<<"forwarded">>, <<"x-forwarded-for">>]`
106106
* `client_headers_sort_fn` - Custom client header sort fn. See `otel_http` for more info. Default: `undefined`
107107
* `handler_id` - Only set when running multiple instances on different endpoints. Default: `otel_cowboy`
108-
* `opt_in_attrs` - Use semantic conventions library to ensure compatability, e.g. `[{?HTTP_REQUEST_BODY_SIZE, true}]`. Default: `[]`
108+
* `opt_in_attrs` - Use semantic conventions library to ensure compatibility, e.g. `[{?HTTP_REQUEST_BODY_SIZE, true}]`. Default: `[]`
109109
* `public_endpoint` - Endpoint is public. Propagated traces will be added as a link. Default: `false`
110110
* `public_endpoint_fn` - Default function returns `false`. See docs for more info.
111111
* `request_headers` - List of request headers to add as attributes. (lowercase). Default: `[]`

instrumentation/opentelemetry_req/lib/opentelemetry_req.ex

+3-3
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ defmodule OpentelemetryReq do
2929
default: [],
3030
type_spec: quote(do: opt_in_attrs()),
3131
doc: """
32-
Opt-in and experimental attributes. Use semantic conventions library to ensure compatability, e.g. `[{HTTPAttributes.http_request_body_size(), true}]`
32+
Opt-in and experimental attributes. Use semantic conventions library to ensure compatibility, e.g. `[{HTTPAttributes.http_request_body_size(), true}]`
3333
3434
#{Enum.map_join(opt_ins, "\n\n", &" * `#{inspect(&1)}`")}
3535
"""
@@ -56,7 +56,7 @@ defmodule OpentelemetryReq do
5656
]
5757
)
5858

59-
@typedoc "Use semantic conventions library to ensure compatability, e.g. `HTTPAttributes.http_request_body_size()`"
59+
@typedoc "Use semantic conventions library to ensure compatibility, e.g. `HTTPAttributes.http_request_body_size()`"
6060
@type opt_in_attr() ::
6161
unquote(HTTPAttributes.http_request_body_size())
6262
| unquote(HTTPAttributes.http_response_body_size())
@@ -95,7 +95,7 @@ defmodule OpentelemetryReq do
9595
### Opt-in Semantic Convention Attributes
9696
9797
Otel SemConv requires users to explicitly opt in for any attribute with a
98-
requirement level of `opt-in` or `experimental`. To ensure compatability, always use the
98+
requirement level of `opt-in` or `experimental`. To ensure compatibility, always use the
9999
SemConv attribute.
100100
101101
Example:

0 commit comments

Comments
 (0)