Skip to content

chore(docs): use contractions for informal tone#1664

Merged
tobz merged 2 commits into
mainfrom
tobz/docs-cleanup-contractions
May 15, 2026
Merged

chore(docs): use contractions for informal tone#1664
tobz merged 2 commits into
mainfrom
tobz/docs-cleanup-contractions

Conversation

@tobz
Copy link
Copy Markdown
Member

@tobz tobz commented May 15, 2026

Summary

This PR fixes all violations for the Google.Contractions style rule in Vale. Specifically, replacing formal usages of two-word contractions: don't instead of does not, and so on. The majority of contractions in play here are "negation contractions", which Google's Style Guide provides a meaningful justification for:

In particular, we recommend using negation contractions such as isn't, don't, and can't. It's easy for a reader to miss the word not when they're scanning, whereas it's harder to misread don't as do.

This drops the number of Vale violations for the Google.Contractions rule from 786 to five.

Change Type

  • Bug fix
  • New feature
  • Non-functional (chore, refactoring, docs)
  • Performance

How did you test this PR?

  • Ran make check-docs before and after and verified the drop in violation count for the Google.Contractions rule.
  • make check-clippy passes cleanly.

References

N/A

@dd-octo-sts dd-octo-sts Bot added area/core Core functionality, event model, etc. area/io General I/O and networking. area/config Configuration. area/components Sources, transforms, and destinations. area/memory Memory bounds and memory management. source/dogstatsd DogStatsD source. transform/aggregate Aggregate transform. transform/chained Chained transform. transform/host-enrichment Host Enrichment synchronous transform. area/observability Internal observability of ADP and Saluki. area/docs Reference documentation. encoder/buffered-incremental Buffered Incremental encoder. encoder/datadog-metrics Datadog Metrics encoder. encoder/datadog-stats Datadog APM Stats encoder. encoder/datadog-traces Datadog Traces encoder. forwarder/datadog Datadog forwarder. source/otlp OTLP source. transform/apm-stats APM Stats transform. transform/trace-sampler Trace Sampler synchronous transform. labels May 15, 2026
Copy link
Copy Markdown
Member Author

tobz commented May 15, 2026

@pr-commenter
Copy link
Copy Markdown

pr-commenter Bot commented May 15, 2026

Binary Size Analysis (Agent Data Plane)

Target: c98a45d (baseline) vs 9efe7d6 (comparison) diff
Analysis Type: Stripped binaries (debug symbols excluded)
Baseline Size: 37.39 MiB
Comparison Size: 37.39 MiB
Size Change: +1.56 KiB (+0.00%)
Pass/Fail Threshold: +5%
Result: PASSED ✅

Changes by Module

Module File Size Symbols
anon.755e1b24f8a38c62e47609928be63b14.55.llvm.13170408764035601413 -3.73 KiB 1
anon.cef2c965820659cc217e63c0fca83ae7.133.llvm.8797144201617903803 +3.73 KiB 1
core +2.96 KiB 1480
anon.34e98d5ede58f98aef9c0791654836ab.1.llvm.4069546298221457688 +1.69 KiB 1
anon.cfa82e444ed029560c86d3bd09bbfe84.1.llvm.1558050583342915113 -1.68 KiB 1
anon.240e6872cde4f5279babbc76ce1c985a.2.llvm.7332188793872339937 +1.57 KiB 1
anon.8dd6cff5395c4ae0ee7e181232f8f4d7.3.llvm.5040413938740047295 -1.57 KiB 1
anon.210c875deb8dcc7f96e2cfcbd9e565c7.25.llvm.17043991802426554815 +1.52 KiB 1
anon.9b4c70b795ecf8943bc40120410ae4dc.56.llvm.18083193562899761219 +1.52 KiB 1
anon.21d5539572a42ad38e013a9af051c05a.8.llvm.5173826906676495688 -1.52 KiB 1
anon.856f29a1542878aca71aaff03c79625f.73.llvm.10080610394013852120 -1.52 KiB 1
anon.c1c1d4201d5453d8addd514e97504aaa.15.llvm.8761148779664750621 +1.50 KiB 1
anon.21d5539572a42ad38e013a9af051c05a.6.llvm.5173826906676495688 -1.50 KiB 1
anon.6c77e63edb98769f0f738df7aa3fc435.18.llvm.13772004139671045516 +1.50 KiB 1
anon.0ca6981047c63376b0a8100693147a33.3.llvm.16042516048820772636 -1.50 KiB 1
anon.9630b83d6e0ca6a7304fba6d88808550.1.llvm.11080642961215969193 -1.32 KiB 1
anon.e150d2ec45d4d29231c94a8b91731438.165.llvm.17721115258038591946 +1.32 KiB 1
anon.3a83a7aa436fbeebb17edc20a60b4971.433.llvm.16554411823225781783 +1.25 KiB 1
anon.755e1b24f8a38c62e47609928be63b14.392.llvm.9038243899099302964 +1.25 KiB 1
anon.856f29a1542878aca71aaff03c79625f.81.llvm.10080610394013852120 -1.24 KiB 1

Detailed Symbol Changes

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  [NEW] +3.73Ki  [NEW]     +16    anon.cef2c965820659cc217e63c0fca83ae7.133.llvm.8797144201617903803
  [NEW] +3.34Ki  [NEW]     +47    _<http_body_util::combinators::map_err::MapErr<B,F> as http_body::Body>::size_hint::h4e59e781aa522757
  [NEW] +1.74Ki  [NEW]     +33    core::ptr::drop_in_place<http_body_util::combinators::map_err::MapErr<tonic::codec::encode::EncodeBody<tonic_prost::codec::ProstEncoder<otlp_protos::otlp_include::opentelemetry::proto::collector::trace::v1::ExportTraceServiceResponse>,tokio_stream::once::Once<core::result::Result<otlp_protos::otlp_include::opentelemetry::proto::collector::trace::v1::ExportTraceServiceResponse,tonic::status::Status>>>,tonic::status::Status::map_error<tonic::status::Status>>>::hfda0d8aaa17b2a4c
  [NEW] +1.69Ki  [NEW]     +97    anon.34e98d5ede58f98aef9c0791654836ab.1.llvm.4069546298221457688
  [NEW] +1.60Ki  [NEW]    +462    core::ptr::drop_in_place<alloc::boxed::Box<tokio::runtime::task::core::Cell<tokio::runtime::blocking::task::BlockingTask<tokio::fs::read_to_string::read_to_string<&std::path::Path>::{{closure}}::{{closure}}>,tokio::runtime::blocking::schedule::BlockingSchedule>>>::h93c753d37426a2d9
  [NEW] +1.57Ki  [NEW]     +77    anon.240e6872cde4f5279babbc76ce1c985a.2.llvm.7332188793872339937
  [NEW] +1.54Ki  [NEW] +1.31Ki    tokio::sync::broadcast::Shared<T>::notify_rx::hfde4c12586a22f46
  +0.0% +1.53Ki  [ = ]       0    [8571 Others]
  [NEW] +1.52Ki  [NEW]     +22    anon.210c875deb8dcc7f96e2cfcbd9e565c7.25.llvm.17043991802426554815
  [NEW] +1.52Ki  [NEW]     +22    anon.9b4c70b795ecf8943bc40120410ae4dc.56.llvm.18083193562899761219
  [NEW] +1.50Ki  [NEW]     +92    anon.c1c1d4201d5453d8addd514e97504aaa.15.llvm.8761148779664750621
  [DEL] -1.50Ki  [DEL]     -92    anon.21d5539572a42ad38e013a9af051c05a.6.llvm.5173826906676495688
  [DEL] -1.52Ki  [DEL]     -22    anon.21d5539572a42ad38e013a9af051c05a.8.llvm.5173826906676495688
  [DEL] -1.52Ki  [DEL]     -22    anon.856f29a1542878aca71aaff03c79625f.73.llvm.10080610394013852120
  [DEL] -1.55Ki  [DEL] -1.31Ki    tokio::sync::broadcast::Shared<T>::notify_rx::h6d4c731163919e60
  [DEL] -1.57Ki  [DEL]     -77    anon.8dd6cff5395c4ae0ee7e181232f8f4d7.3.llvm.5040413938740047295
  [DEL] -1.59Ki  [DEL]    -462    core::ptr::drop_in_place<alloc::boxed::Box<tokio::runtime::task::core::Cell<tokio::runtime::blocking::task::BlockingTask<tokio::fs::read::read<&std::path::Path>::{{closure}}::{{closure}}>,tokio::runtime::blocking::schedule::BlockingSchedule>>>::hb49d4b30cb4531cc
  [DEL] -1.68Ki  [DEL]     -97    anon.cfa82e444ed029560c86d3bd09bbfe84.1.llvm.1558050583342915113
  [DEL] -1.74Ki  [DEL]     -33    core::ptr::drop_in_place<http_body_util::combinators::map_err::MapErr<tonic::codec::encode::EncodeBody<tonic_prost::codec::ProstEncoder<otlp_protos::otlp_include::opentelemetry::proto::collector::metrics::v1::ExportMetricsServiceResponse>,tokio_stream::once::Once<core::result::Result<otlp_protos::otlp_include::opentelemetry::proto::collector::metrics::v1::ExportMetricsServiceResponse,tonic::status::Status>>>,tonic::status::Status::map_error<tonic::status::Status>>>::h21fc08b01cc7befc
  [DEL] -3.32Ki  [DEL]     -47    _<http_body_util::combinators::map_err::MapErr<B,F> as http_body::Body>::size_hint::hc4e1fd9169c57358
  [DEL] -3.73Ki  [DEL]     -16    anon.755e1b24f8a38c62e47609928be63b14.55.llvm.13170408764035601413
  +0.0% +1.56Ki  [ = ]       0    TOTAL

@tobz tobz added the type/chore Updates to dependencies or general "administrative" tasks necessary to maintain the codebase/repo. label May 15, 2026
@tobz tobz marked this pull request as ready for review May 15, 2026 18:35
@tobz tobz requested a review from a team as a code owner May 15, 2026 18:35
Copilot AI review requested due to automatic review settings May 15, 2026 18:35
Base automatically changed from tobz/docs-cleanup-latin-abbrevations to main May 15, 2026 18:38
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@tobz tobz force-pushed the tobz/docs-cleanup-contractions branch from 4109b7b to 9efe7d6 Compare May 15, 2026 18:46
@pr-commenter
Copy link
Copy Markdown

pr-commenter Bot commented May 15, 2026

Regression Detector (Agent Data Plane)

Run ID: b36d65fb-50a3-41c5-86d7-5540eec6c828
Baseline: c98a45d9 · Comparison: 9efe7d68 · Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment (35)

Experiments configured erratic: true are tagged (ignored) and skipped when determining which experiments regressed or improved. Experiments which are detected as erratic at runtime are tagged (erratic) to flag that the run's sample dispersion was high, but their regression / improvement signal still counts.

experiment goal Δ mean % links
dsd_uds_512kb_3k_contexts_cpu (erratic) cpu ⚪ +4.80 metrics profiles logs
otlp_ingest_logs_5mb_memory (ignored) memory ⚪ +3.81 metrics profiles logs
otlp_ingest_metrics_5mb_memory memory ⚪ +1.88 metrics profiles logs
otlp_ingest_logs_5mb_cpu (ignored) cpu ⚪ +1.81 metrics profiles logs
dsd_uds_500mb_3k_contexts_throughput throughput ⚪ -1.21 metrics profiles logs
dsd_uds_500mb_3k_contexts_memory memory ⚪ +0.39 metrics profiles logs
dsd_uds_100mb_3k_contexts_cpu (erratic) cpu ⚪ +0.34 metrics profiles logs
dsd_uds_100mb_3k_contexts_memory memory ⚪ +0.18 metrics profiles logs
quality_gates_rss_idle memory ⚪ +0.13 metrics profiles logs
otlp_ingest_traces_ottl_transform_5mb_memory memory ⚪ +0.08 metrics profiles logs
otlp_ingest_traces_ottl_filtering_5mb_memory memory ⚪ +0.06 metrics profiles logs
otlp_ingest_traces_5mb_memory memory ⚪ +0.05 metrics profiles logs
otlp_ingest_traces_ottl_transform_5mb_throughput throughput ⚪ -0.02 metrics profiles logs
dsd_uds_10mb_3k_contexts_throughput throughput ⚪ -0.01 metrics profiles logs
otlp_ingest_metrics_5mb_throughput throughput ⚪ -0.01 metrics profiles logs
otlp_ingest_logs_5mb_throughput (ignored) throughput ⚪ -0.00 metrics profiles logs
dsd_uds_1mb_3k_contexts_throughput throughput ⚪ +0.00 metrics profiles logs
dsd_uds_512kb_3k_contexts_throughput throughput ⚪ +0.00 metrics profiles logs
dsd_uds_100mb_3k_contexts_throughput throughput ⚪ +0.00 metrics profiles logs
dsd_uds_500mb_3k_contexts_cpu (erratic) cpu ⚪ -0.03 metrics profiles logs
dsd_uds_1mb_3k_contexts_memory memory ⚪ -0.06 metrics profiles logs
otlp_ingest_traces_5mb_throughput throughput ⚪ +0.13 metrics profiles logs
otlp_ingest_traces_ottl_filtering_5mb_cpu (erratic) cpu ⚪ -0.14 metrics profiles logs
otlp_ingest_traces_ottl_filtering_5mb_throughput throughput ⚪ +0.16 metrics profiles logs
quality_gates_rss_dsd_ultraheavy memory ⚪ -0.28 metrics profiles logs
otlp_ingest_traces_5mb_cpu (erratic) cpu ⚪ -0.30 metrics profiles logs
dsd_uds_512kb_3k_contexts_memory memory ⚪ -0.33 metrics profiles logs
quality_gates_rss_dsd_low memory ⚪ -0.33 metrics profiles logs
quality_gates_rss_dsd_heavy memory ⚪ -0.39 metrics profiles logs
quality_gates_rss_dsd_medium memory ⚪ -0.43 metrics profiles logs
dsd_uds_10mb_3k_contexts_memory memory ⚪ -0.59 metrics profiles logs
otlp_ingest_metrics_5mb_cpu (erratic) cpu ⚪ -0.66 metrics profiles logs
otlp_ingest_traces_ottl_transform_5mb_cpu (erratic) cpu ⚪ -0.73 metrics profiles logs
dsd_uds_10mb_3k_contexts_cpu (erratic) cpu ⚪ -1.39 metrics profiles logs
dsd_uds_1mb_3k_contexts_cpu (erratic) cpu ⚪ -2.64 metrics profiles logs
Bounds Checks: ✅ Passed (5)
experiment check replicates observed links
quality_gates_rss_dsd_heavy memory_usage 10/10 ✅ 123 MiB ≤ 140 MiB metrics profiles logs
quality_gates_rss_dsd_low memory_usage 10/10 ✅ 39.3 MiB ≤ 50 MiB metrics profiles logs
quality_gates_rss_dsd_medium memory_usage 10/10 ✅ 59.8 MiB ≤ 75 MiB metrics profiles logs
quality_gates_rss_dsd_ultraheavy memory_usage 10/10 ✅ 177 MiB ≤ 200 MiB metrics profiles logs
quality_gates_rss_idle memory_usage 10/10 ✅ 27 MiB ≤ 40 MiB metrics profiles logs
Explanation

A change is flagged as a regression when |Δ mean %| > 5.00% in the regressing direction for its optimization goal AND SMP marks the experiment as a regression (is_regression: true). Improvements use the matching criteria for the improving direction. Experiments configured erratic: true (tagged (ignored)) are skipped outright; experiments detected as erratic at runtime (tagged (erratic)) still count, since that flag describes sample dispersion rather than directional certainty. The Δ mean % cell is colored accordingly: 🟢 = improvement, 🔴 = regression, ⚪ = neutral. Reduction in CPU or memory is an improvement; reduction in ingress throughput is a regression.

@tobz tobz merged commit 5ff8571 into main May 15, 2026
78 checks passed
@tobz tobz deleted the tobz/docs-cleanup-contractions branch May 15, 2026 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/components Sources, transforms, and destinations. area/config Configuration. area/core Core functionality, event model, etc. area/docs Reference documentation. area/io General I/O and networking. area/memory Memory bounds and memory management. area/observability Internal observability of ADP and Saluki. encoder/buffered-incremental Buffered Incremental encoder. encoder/datadog-metrics Datadog Metrics encoder. encoder/datadog-stats Datadog APM Stats encoder. encoder/datadog-traces Datadog Traces encoder. forwarder/datadog Datadog forwarder. source/dogstatsd DogStatsD source. source/otlp OTLP source. transform/aggregate Aggregate transform. transform/apm-stats APM Stats transform. transform/chained Chained transform. transform/host-enrichment Host Enrichment synchronous transform. transform/trace-sampler Trace Sampler synchronous transform. type/chore Updates to dependencies or general "administrative" tasks necessary to maintain the codebase/repo.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants