Skip to content

Commit eff6c47

Browse files
authored
chore(docs): minor doc fixes (open-telemetry#1726)
1 parent 4bf9bf8 commit eff6c47

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

docs/otap_basics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ and OpenTelemetry Protocol (OTLP).
3434

3535
OTAP is a sort of "protocol on top of a protocol". At the outer layer is a gRPC
3636
service defined via protobuf. Within that we have Apache Arrow Interprocess
37-
Communication (Arrow IPC). OTAP leverages both it's own mechanisms at the gRPC
37+
Communication (Arrow IPC). OTAP leverages both its own mechanisms at the gRPC
3838
layer and existing Arrow IPC mechanisms to reliably transport telemetry signals
3939
from a Client to a Server.
4040

@@ -227,7 +227,7 @@ To understand the protocol, it's enough to know _what_ you want to create. To
227227
see it in practice, you can take a look at the `Producer` reference
228228
implementation linked at the top of this document.
229229

230-
For simplicity and readablility we'll take some liberties in this section like
230+
For simplicity and readability we'll take some liberties in this section like
231231
trimming down the required fields. You can refer back to the data model for a
232232
full accounting of required and optional fields for every table.
233233

tools/pipeline_perf_test/orchestrator/docs/plugin_development.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ based on the test suite's YAML configuration.
8585
The following sections walk through the anatomy of a plugin and how to implement
8686
each type.
8787

88-
Reporting Strategies have additional considerations, and are covered seperately
88+
Reporting Strategies have additional considerations, and are covered separately
8989
in the [Reports Guide](./reports.md).
9090

9191
---
@@ -175,7 +175,7 @@ Every plugin class can define a `PLUGIN_META` attribute with the following field
175175
| `supported_contexts` | List of context types the plugin supports |
176176
| `installs_hooks` | Hook types the plugin automatically installs (if any) |
177177
| `yaml_example` | Example YAML block showing how to use the plugin |
178-
| `cli_flags` | List of additional cli flags to inject into the argpase parser |
178+
| `cli_flags` | List of additional cli flags to inject into the argparse parser |
179179

180180
This metadata is used by documentation generators, validation tools, and helps
181181
developers quickly understand how to use the plugin.
@@ -279,7 +279,7 @@ scope.
279279
| `BaseContext` | Base Class for all Context Types | Provides core features: logging, telemetry, runtime info |
280280
| `FrameworkElementContext` | Inherited Class suite/step/scenario | Base class for contexts created for Suite, Scenario, Steps main execution |
281281
| `SuiteContext` | Indirect access by any descendant ctx | Root CTX instance in the hierarchy, holds shared runtimes, telemetry, etc |
282-
| `ScendarioContext` | Indirect access by any descendant ctx | Provides access to the test scenario defition |
282+
| `ScenarioContext` | Indirect access by any descendant ctx | Provides access to the test scenario definition |
283283
| `StepContext` | Passed to All (non-hook) Strategies | Provides access to the step, any related component, and access to ancestors |
284284
| `ComponentHookContext` | Passed to Component-level hooks | Includes access to the component being manipulated |
285285
| `FrameworkElementHookContext` | Passed to Suite/scenario/step hooks | Includes access to the element (suite, scenario, step) being manipulated |
@@ -290,7 +290,7 @@ like so:
290290
```shell
291291
|_ SuiteContext(FrameworkElementContext)
292292
|_ FrameworkElementHookContext(BaseContext) # If hook installed on Suite
293-
|_ ScendarioContext(FrameworkElementContext)
293+
|_ ScenarioContext(FrameworkElementContext)
294294
|_ FrameworkElementHookContext(BaseContext) # If hook installed on Scenario
295295
|_ StepContext(FrameworkElementContext)
296296
|_ FrameworkElementHookContext(BaseContext) # If hook installed on Step
@@ -306,7 +306,7 @@ The BaseContext provides the following useful methods on all Context Types:
306306
- get_component_by_name(name) - Retrieves named component from the suite object
307307
- get_suite() - Retrieves root test suite object.
308308
- get_metadata() - Returns the metadata dictionary for the context (merged with
309-
it's ancestors)
309+
its ancestors)
310310
- record_event(event_name, timestamp_unix_nanos, **kwargs) - Records a telemetry
311311
event enriched with context metadata.
312312
- get_logger(logger_name) - Returns a LoggerAdapter with context metadata injected.

0 commit comments

Comments
 (0)