Skip to content

Commit 1414379

Browse files
committed
chore(docs): fix vale lint errors
Replaces 'e.g.' with 'for example' in doc comments (Google.Latin), swaps an em dash for a semicolon in a runtime-field docstring (Google.EmDash), and adds 'launchd' to the technical vocabulary. Also drops docs/superpowers/plans/2026-05-21-macos-native-integration-tests.md; the plan was a one-time implementation artifact and the PR description on #1735 supersedes it.
1 parent 02bd327 commit 1414379

6 files changed

Lines changed: 8 additions & 948 deletions

File tree

.vale/styles/config/vocabularies/technical/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,3 +225,4 @@ libtest
225225
mpmc
226226
dhat
227227
profiler
228+
launchd

bin/correctness/airlock/src/native.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ use tracing::{debug, warn};
2929
/// Shared cell that receives the exit code of a spawned [`NativeProcess`].
3030
///
3131
/// The cell is populated by the background exit watcher when the child exits on its own, or by
32-
/// [`NativeProcess::cleanup`] when the test tears down. Consumers (e.g., the
32+
/// [`NativeProcess::cleanup`] when the test tears down. Consumers (for example, the
3333
/// `process_exits_with` assertion in panoramic) read the cell after the exit token fires.
3434
///
3535
/// The inner `Option<i32>` is `None` if the process was terminated by signal rather than exiting
@@ -52,7 +52,7 @@ pub struct NativeProcessConfig {
5252
/// If `true`, the spawned process is placed into a new process group with itself as the
5353
/// group leader, and [`cleanup`][NativeProcess::cleanup] signals the entire group instead of
5454
/// only the immediate child. This is essential when the spawned binary forks helpers that
55-
/// outlive their parent (e.g., the Datadog Core Agent spawns `trace-agent` and
55+
/// outlive their parent (for example, the Datadog Core Agent spawns `trace-agent` and
5656
/// `process-agent` which orphan onto launchd if only the parent is killed).
5757
pub use_process_group: bool,
5858
}
@@ -240,7 +240,7 @@ impl NativeProcess {
240240
/// cancels the exit token.
241241
pub async fn cleanup(mut self) {
242242
// If we asked for a process group, first send SIGTERM to the entire group. This gives
243-
// descendants (e.g., trace-agent, process-agent spawned by the Datadog Core Agent) a
243+
// descendants (for example, trace-agent, process-agent spawned by the Datadog Core Agent) a
244244
// chance to shut down cleanly before we hard-kill them. After a brief grace period we
245245
// send SIGKILL to the group to guarantee no orphans remain.
246246
#[cfg(unix)]
@@ -274,7 +274,7 @@ impl NativeProcess {
274274
if let Some(handle) = self.exit_task.take() {
275275
let _ = handle.await;
276276
}
277-
// Defensive: make sure the token is fired even if the watcher never set it (e.g., on a
277+
// Defensive: make sure the token is fired even if the watcher never set it (for example, on a
278278
// failed wait).
279279
self.exit_token.cancel();
280280
for handle in self.log_tasks.drain(..) {

bin/correctness/panoramic/src/assertions/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ pub struct AssertionContext {
105105
/// Name of the container being tested.
106106
pub container_name: String,
107107
/// Whether the test is running natively (no container). When `true`, assertions that would
108-
/// otherwise reach into a container (e.g., reading a file via `docker exec`) should operate
108+
/// otherwise reach into a container (for example, reading a file via `docker exec`) should operate
109109
/// against the host filesystem / local process instead.
110110
pub is_native: bool,
111111
/// Exit code of the native target process, populated once it exits. `None` on the docker

bin/correctness/panoramic/src/cli.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ pub struct RunCommand {
3030
#[argh(option, short = 't')]
3131
pub tests: Option<String>,
3232

33-
/// run only tests with the given runtime (e.g., `docker`, `native_macos`, `kubernetes_in_docker`).
33+
/// run only tests with the given runtime (for example, `docker`, `native_macos`, `kubernetes_in_docker`).
3434
/// Can be combined with `-t` to further restrict by name.
3535
#[argh(option)]
3636
pub runtime: Option<String>,

bin/correctness/panoramic/src/config.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ pub struct IntegrationConfig {
129129
/// way they would in production. When `false` (the default), only ADP is spawned (standalone
130130
/// mode).
131131
///
132-
/// On the `docker` runtime this field is informational the converged image always runs
132+
/// On the `docker` runtime this field is informational; the converged image always runs
133133
/// both processes via s6.
134134
#[serde(default)]
135135
pub requires_core_agent: bool,

0 commit comments

Comments
 (0)