Skip to content

Commit eac368a

Browse files
Copilotcijothomas
andauthored
chore: Fix spelling errors and typos in documentation (#3044)
Co-authored-by: Cijo Thomas <[email protected]>
1 parent 2bf8175 commit eac368a

File tree

6 files changed

+35
-12
lines changed

6 files changed

+35
-12
lines changed

.cspell.json

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
"ignoreWords": [
1313
"otel",
1414
"rustdoc",
15-
"rustfilt"
15+
"rustfilt",
16+
"webkpi"
1617
],
1718
// these are words that are always considered incorrect.
1819
"flagWords": [
@@ -34,47 +35,61 @@
3435
"Bhasin",
3536
"Björn",
3637
"BLRP",
38+
"chrono",
3739
"Cijo",
3840
"clippy",
3941
"clonable",
4042
"codecov",
43+
"dashmap",
4144
"datapoint",
4245
"deque",
4346
"Dirkjan",
4447
"docsrs",
4548
"Dwarnings",
49+
"eprintln",
4650
"EPYC",
4751
"flamegraph",
4852
"Gerring",
53+
"grpcio",
4954
"Grübel",
5055
"hasher",
56+
"impls",
57+
"isahc",
5158
"Isobel",
5259
"jaegertracing",
5360
"Kühle",
5461
"Kumar",
5562
"Lalit",
5663
"LIBCLANG",
64+
"logrecord",
5765
"MILLIS",
66+
"mpsc",
5867
"msrv",
5968
"mykey",
69+
"myunit",
6070
"myvalue",
6171
"nocapture",
6272
"Ochtman",
6373
"opentelemetry",
74+
"openzipkin",
75+
"otcorrelations",
6476
"OTELCOL",
6577
"OTLP",
6678
"periodicreader",
6779
"Pillai",
6880
"pprof",
81+
"protos",
6982
"prost",
7083
"protoc",
7184
"quantile",
85+
"quantiles",
7286
"Redelmeier",
7387
"reqwest",
7488
"rstest",
7589
"runtimes",
7690
"rustc",
7791
"rustls",
92+
"schemars",
7893
"semconv",
7994
"serde",
8095
"shoppingcart",
@@ -83,10 +98,18 @@
8398
"testcontainers",
8499
"testresults",
85100
"thiserror",
101+
"traceparent",
102+
"Traceparent",
86103
"tracerprovider",
104+
"tracestate",
105+
"UCUM",
87106
"Umesan",
107+
"unsampled",
88108
"updown",
109+
"urlencoding",
110+
"usize",
89111
"Utkarsh",
112+
"webpki",
90113
"Zhongyang",
91114
"zipkin"
92115
],

docs/adr/001_error_handling.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44

55
## Summary
66

7-
This ADR describes the general pattern we will follow when modelling errors in public API interfaces - that is, APIs that are exposed to users of the project's published crates. It summarises the discussion and final option from [#2571](https://github.com/open-telemetry/opentelemetry-rust/issues/2571); for more context check out that issue.
7+
This ADR describes the general pattern we will follow when modelling errors in public API interfaces - that is, APIs that are exposed to users of the project's published crates. It summarizes the discussion and final option from [#2571](https://github.com/open-telemetry/opentelemetry-rust/issues/2571); for more context check out that issue.
88

99
We will focus on the exporter traits in this example, but the outcome should be applied to _all_ public traits and their fallible operations.
1010

1111
These include [SpanExporter](https://github.com/open-telemetry/opentelemetry-rust/blob/eca1ce87084c39667061281e662d5edb9a002882/opentelemetry-sdk/src/trace/export.rs#L18), [LogExporter](https://github.com/open-telemetry/opentelemetry-rust/blob/eca1ce87084c39667061281e662d5edb9a002882/opentelemetry-sdk/src/logs/export.rs#L115), and [PushMetricExporter](https://github.com/open-telemetry/opentelemetry-rust/blob/eca1ce87084c39667061281e662d5edb9a002882/opentelemetry-sdk/src/metrics/exporter.rs#L11) which form part of the API surface of `opentelemetry-sdk`.
1212

13-
There are various ways to handle errors on trait methods, including swallowing them and logging, panicing, returning a shared global error, or returning a method-specific error. We strive for consistency, and we want to be sure that we've put enough thought into what this looks like that we don't have to make breaking interface changes unecessarily in the future.
13+
There are various ways to handle errors on trait methods, including swallowing them and logging, panicking, returning a shared global error, or returning a method-specific error. We strive for consistency, and we want to be sure that we've put enough thought into what this looks like that we don't have to make breaking interface changes unnecessarily in the future.
1414

1515
## Design Guidance
1616

@@ -69,7 +69,7 @@ trait MyTrait {
6969

7070
## 3. Consolidate error types between signals where we can, let them diverge where we can't
7171

72-
Consider the `Exporter`s mentioned earlier. Each of them has the same failure indicators - as dicated by the OpenTelemetry spec - and we will
72+
Consider the `Exporter`s mentioned earlier. Each of them has the same failure indicators - as dictated by the OpenTelemetry spec - and we will
7373
share the error types accordingly:
7474

7575
**Don't do this** - each signal has its own error type, despite having exactly the same failure cases:

opentelemetry-http/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Released 2024-Sep-30
5353

5454
## v0.12.0
5555

56-
- Add `reqwest-rustls-webkpi-roots` feature flag to configure [`reqwest`](https://docs.rs/reqwest/0.11.27/reqwest/index.html#optional-features) to use embedded `webkpi-roots`.
56+
- Add `reqwest-rustls-webpki-roots` feature flag to configure [`reqwest`](https://docs.rs/reqwest/0.11.27/reqwest/index.html#optional-features) to use embedded `webpki-roots`.
5757
- Update `opentelemetry` dependency version to 0.23
5858

5959
## v0.11.1

opentelemetry-otlp/CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Released 2025-Mar-21
2727
- Update `opentelemetry-http` dependency version to 0.29
2828
- Update `opentelemetry-proto` dependency version to 0.29
2929

30-
- The `OTEL_EXPORTER_OTLP_TIMEOUT`, `OTEL_EXPORTER_OTLP_TRACES_TIMEOUT`, `OTEL_EXPORTER_OTLP_METRICS_TIMEOUT` and `OTEL_EXPORTER_OTLP_LOGS_TIMEOUT` are changed from seconds to miliseconds.
30+
- The `OTEL_EXPORTER_OTLP_TIMEOUT`, `OTEL_EXPORTER_OTLP_TRACES_TIMEOUT`, `OTEL_EXPORTER_OTLP_METRICS_TIMEOUT` and `OTEL_EXPORTER_OTLP_LOGS_TIMEOUT` are changed from seconds to milliseconds.
3131
- Fixed `.with_headers()` in `HttpExporterBuilder` to correctly support multiple key/value pairs. [#2699](https://github.com/open-telemetry/opentelemetry-rust/pull/2699)
3232
- Fixed
3333
[#2770](https://github.com/open-telemetry/opentelemetry-rust/issues/2770)
@@ -199,7 +199,7 @@ now use `.with_resource(RESOURCE::default())` to configure Resource when using
199199
### Added
200200

201201
- Added `DeltaTemporalitySelector` ([#1568])
202-
- Add `webkpi-roots` features to `reqwest` and `tonic` backends
202+
- Add `webpki-roots` features to `reqwest` and `tonic` backends
203203

204204
[#1568]: https://github.com/open-telemetry/opentelemetry-rust/pull/1568
205205

opentelemetry-sdk/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ Released 2025-Mar-21
189189
needs to mutate state, it should rely on interior mutability.
190190
[2764](https://github.com/open-telemetry/opentelemetry-rust/pull/2764)
191191
- *Breaking (Affects custom Exporter/Processor authors only)* Removed
192-
`opentelelemetry_sdk::logs::error::{LogError, LogResult}`. These were not
192+
`opentelemetry_sdk::logs::error::{LogError, LogResult}`. These were not
193193
intended to be public. If you are authoring custom processor/exporters, use
194194
`opentelemetry_sdk::error::OTelSdkError` and
195195
`opentelemetry_sdk::error::OTelSdkResult`.

opentelemetry/CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ predictable and efficient observability pipelines.
3535

3636
Release 2025-Apr-01
3737

38-
- Bug Fix: Re-export `WithContext` at `opentelemetry::trace::context::WithContext` [#2879](https://github.com/open-telemetry/opentelemetry-rust/pull/2879) to restore backwards compatability
38+
- Bug Fix: Re-export `WithContext` at `opentelemetry::trace::context::WithContext` [#2879](https://github.com/open-telemetry/opentelemetry-rust/pull/2879) to restore backwards compatibility
3939
- The new path for `WithContext` and `FutureExt` are in `opentelemetry::context` as they are independent of the trace signal. Users should prefer this path.
4040

4141
## 0.29.0
@@ -504,7 +504,7 @@ and SDK are still unstable.
504504
- Use current span for SDK-less context propagation #510
505505
- Always export span batch when limit reached #519
506506
- Rename message events to events #530
507-
- Update resource merge behaviour #537
507+
- Update resource merge behavior #537
508508
- Ignore links with invalid context #538
509509

510510
## Removed
@@ -529,7 +529,7 @@ use `opentelemetry::global::shutdown_tracer_provider` explicitly instead.
529529

530530
## Changed
531531

532-
- Pull configrations from environment variables by default when creating BatchSpanProcessor #445
532+
- Pull configurations from environment variables by default when creating BatchSpanProcessor #445
533533
- Convert doc links to intra-doc #466
534534
- Switch to Cow for event names #471
535535
- Use API to configure async runtime instead of features #481
@@ -826,7 +826,7 @@ use `opentelemetry::global::shutdown_tracer_provider` explicitly instead.
826826
- Make trace and metrics features optional
827827
- ExportResult as specified in the specification
828828
- Add Futures compatibility API
829-
- Added serde serialise support to SpanData
829+
- Added serde serialize support to SpanData
830830
- Separate OpenTelemetry Jaeger crate
831831

832832
### Changed

0 commit comments

Comments
 (0)