chore(docs): replace 'e.g.' with 'for example'#1287
Conversation
There was a problem hiding this comment.
Pull request overview
This PR standardizes documentation phrasing by replacing “e.g.” with “for example” across the repository.
Changes:
- Replaces “e.g.” with “for example” in Rust doc comments, Markdown docs, and assorted scripts/config comments.
- Updates a few user-facing strings/comments that contain example text (such as error messages and inline docs).
Reviewed changes
Copilot reviewed 49 out of 62 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| test/smp/regression/adp/generate_experiments.py | Updates docstrings/comments to use “for example”. |
| test/smp/README.md | Updates README wording to use “for example”. |
| test/one-off/analyze-binary-size.py | Updates docstring wording to use “for example”. |
| lib/stringtheory/src/lib.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-tls/src/lib.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-io/src/net/stream.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-io/src/net/listener.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-io/src/net/ipc.rs | Updates test comments to use “for example”. |
| lib/saluki-io/src/deser/codec/dogstatsd/mod.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-env/src/workload/entity.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-env/src/helpers/remote_agent/client.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-core/src/topology/graph.rs | Updates test comments to use “for example”. |
| lib/saluki-core/src/state/reflector.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-core/src/runtime/supervisor.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-core/src/data_model/event/trace/mod.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-core/src/data_model/event/metric/mod.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-core/src/data_model/event/log/mod.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-core/src/components/transforms/mod.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-core/examples/basic_supervisor.rs | Updates example comment to use “for example”. |
| lib/saluki-context/src/tags/mod.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-components/src/sources/otlp/metrics/config.rs | Updates comments to use “for example”. |
| lib/saluki-components/src/forwarders/datadog/mod.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-components/src/encoders/datadog/metrics/mod.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-components/src/common/otlp/traces/transform.rs | Updates comments to use “for example”. |
| lib/saluki-components/src/common/otlp/traces/normalize.rs | Updates comments to use “for example”. |
| lib/saluki-components/src/common/datadog/transaction.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-components/src/common/datadog/obfuscation.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-components/src/common/datadog/endpoints.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-components/src/common/datadog/apm.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-common/src/scrubber.rs | Updates comments/docs to use “for example”. |
| lib/saluki-app/src/tls.rs | Updates Rust doc comments to use “for example”. |
| lib/saluki-app/src/metrics/mod.rs | Updates Rust doc comments to use “for example”. |
| lib/ottl/src/tests.rs | Updates test comments to use “for example”. |
| lib/ottl/src/parser/eval.rs | Updates Rust doc comments to use “for example”. |
| lib/ottl/src/parser/ast.rs | Updates Rust doc comments to use “for example”. |
| lib/ottl/src/mod.rs | Updates Rust doc comments to use “for example”. |
| lib/ottl/src/helpers.rs | Updates module docs to use “for example”. |
| lib/ottl/src/editors.rs | Updates module docs to use “for example”. |
| lib/ottl/docs/ebnf/ottl.peg | Updates grammar commentary to use “for example”. |
| lib/ottl/docs/README.md | Updates docs to use “for example”. |
| lib/memory-accounting/src/verifier.rs | Updates Rust doc comments to use “for example”. |
| lib/memory-accounting/src/registry.rs | Updates Rust doc comments to use “for example”. |
| lib/ddsketch/src/canonical/store/collapsing_lowest.rs | Updates Rust doc comments to use “for example”. |
| lib/ddsketch/src/canonical/store/collapsing_highest.rs | Updates Rust doc comments to use “for example”. |
| lib/ddsketch/src/canonical/sketch.rs | Updates Rust doc comments to use “for example”. |
| docs/reference/architecture/index.md | Updates docs to use “for example”. |
| bin/correctness/panoramic/src/tui.rs | Updates Rust doc comments to use “for example”. |
| bin/correctness/panoramic/src/config.rs | Updates Rust doc comments to use “for example”. |
| bin/correctness/millstone/src/target.rs | Updates Rust doc comments to use “for example”. |
| bin/correctness/millstone/src/driver.rs | Updates Rust doc comments to use “for example”. |
| bin/correctness/ground-truth/src/config.rs | Updates Rust doc comments to use “for example”. |
| bin/correctness/ground-truth/src/analysis/metrics/types.rs | Updates comments/docs to use “for example”. |
| bin/correctness/ground-truth/src/analysis/metrics/mod.rs | Updates comments/docs to use “for example”. |
| bin/correctness/README.md | Updates README wording to use “for example”. |
| bin/agent-data-plane/src/components/ottl_transform_processor/span_context.rs | Updates module docs and an error message to use “for example”. |
| bin/agent-data-plane/src/components/ottl_transform_processor/README.md | Updates README wording to use “for example”. |
| bin/agent-data-plane/src/components/ottl_filter_processor/mod.rs | Updates Rust doc comments to use “for example”. |
| bin/agent-data-plane/src/components/ottl_filter_processor/README.md | Updates README wording to use “for example”. |
| bin/agent-data-plane/src/cli/debug/mod.rs | Updates CLI help text to use “for example”. |
| AGENTS.md | Updates documentation guidance to use “for example”. |
| .gitlab/e2e.yml | Updates CI comment to use “for example”. |
| .claude/skills/binary-size-analysis/SKILL.md | Updates skill doc wording to use “for example”. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
89623ae to
c8c44cf
Compare
58fb27f to
872fdc5
Compare
872fdc5 to
b291b52
Compare
c8c44cf to
640877b
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 49 out of 62 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Binary Size Analysis (Agent Data Plane)Target: d890d6b (baseline) vs c4e321a (comparison) diff
|
| Module | File Size | Symbols |
|---|---|---|
unicode_segmentation |
-24 B | 1 |
agent_data_plane::cli::debug |
+16 B | 2 |
agent_data_plane::components::ottl_transform_processor |
+15 B | 1 |
[sections] |
-7 B | 1 |
saluki_components::sources::dogstatsd |
+0 B | 2 |
saluki_components::transforms::dogstatsd_prefix_filter |
+0 B | 42 |
saluki_components::transforms::dogstatsd_mapper |
+0 B | 8 |
core |
+0 B | 14 |
saluki_core::topology::blueprint |
+0 B | 2 |
Detailed Symbol Changes
FILE SIZE VM SIZE
-------------- --------------
[NEW] +27.2Ki [NEW] +27.1Ki saluki_components::sources::dogstatsd::handle_frame::hd09917e17118d1e0
[NEW] +12.1Ki [NEW] +11.9Ki _<saluki_components::transforms::dogstatsd_prefix_filter::DogStatsDPrefixFilter as saluki_core::components::transforms::Transform>::run::_{{closure}}::h4b9be6d35263b2e8
[NEW] +11.7Ki [NEW] +11.4Ki _<saluki_components::transforms::dogstatsd_mapper::DogStatsDMapper as saluki_core::components::transforms::SynchronousTransform>::transform_buffer::hfd73e9c91ecb3d96
[NEW] +7.92Ki [NEW] +7.66Ki _<saluki_components::transforms::dogstatsd_mapper::DogStatsDMapperConfiguration as saluki_core::components::transforms::builder::SynchronousTransformBuilder>::build::_{{closure}}::h5dc9eb48d8eab5b2
[NEW] +1.47Ki [NEW] +1.31Ki core::ptr::drop_in_place<saluki_components::transforms::dogstatsd_mapper::DogStatsDMapperConfiguration>::h424324b4e3fab998
[NEW] +1.45Ki [NEW] +1.20Ki _<saluki_components::transforms::dogstatsd_prefix_filter::DogStatsDPrefixFilterConfiguration as saluki_core::components::transforms::builder::TransformBuilder>::build::_{{closure}}::h5eeb545ed2b3bf80
[NEW] +1.29Ki [NEW] +1.17Ki saluki_core::topology::blueprint::TopologyBlueprint::add_transform::hc9fe5bbc5fd69030
[NEW] +1.21Ki [NEW] +1.01Ki _<saluki_components::transforms::dogstatsd_mapper::DogStatsDMapperConfiguration as memory_accounting::MemoryBounds>::specify_bounds::ha218618be246b75f
[NEW] +1.07Ki [NEW] +838 core::ptr::drop_in_place<<saluki_components::transforms::dogstatsd_prefix_filter::DogStatsDPrefixFilter as saluki_core::components::transforms::Transform>::run::{{closure}}>::hde4240f050fb20d3
[NEW] +1.01Ki [NEW] +868 core::ptr::drop_in_place<saluki_components::transforms::dogstatsd_prefix_filter::DogStatsDPrefixFilterConfiguration>::hbbe4da14d1f06740
[DEL] -1.01Ki [DEL] -868 core::ptr::drop_in_place<saluki_components::transforms::dogstatsd_prefix_filter::DogstatsDPrefixFilterConfiguration>::hab7c998b0cd74e00
[DEL] -1.07Ki [DEL] -838 core::ptr::drop_in_place<<saluki_components::transforms::dogstatsd_prefix_filter::DogstatsDPrefixFilter as saluki_core::components::transforms::Transform>::run::{{closure}}>::hac899a32646189e7
[DEL] -1.21Ki [DEL] -1.01Ki _<saluki_components::transforms::dogstatsd_mapper::DogstatsDMapperConfiguration as memory_accounting::MemoryBounds>::specify_bounds::hd77bfb7d615f2e10
[DEL] -1.29Ki [DEL] -1.17Ki saluki_core::topology::blueprint::TopologyBlueprint::add_transform::hc291167c356a7131
[DEL] -1.45Ki [DEL] -1.20Ki _<saluki_components::transforms::dogstatsd_prefix_filter::DogstatsDPrefixFilterConfiguration as saluki_core::components::transforms::builder::TransformBuilder>::build::_{{closure}}::hae3eaadbead7c2b2
[DEL] -1.47Ki [DEL] -1.31Ki core::ptr::drop_in_place<saluki_components::transforms::dogstatsd_mapper::DogstatsDMapperConfiguration>::h7aa3e936d472efd8
[DEL] -7.92Ki [DEL] -7.66Ki _<saluki_components::transforms::dogstatsd_mapper::DogstatsDMapperConfiguration as saluki_core::components::transforms::builder::SynchronousTransformBuilder>::build::_{{closure}}::h3e4df43216871a0d
[DEL] -11.7Ki [DEL] -11.4Ki _<saluki_components::transforms::dogstatsd_mapper::DogstatsDMapper as saluki_core::components::transforms::SynchronousTransform>::transform_buffer::hefad114bbd2d3b6c
[DEL] -12.1Ki [DEL] -11.9Ki _<saluki_components::transforms::dogstatsd_prefix_filter::DogstatsDPrefixFilter as saluki_core::components::transforms::Transform>::run::_{{closure}}::hc4b2f14bb3b7324d
[DEL] -27.2Ki [DEL] -27.1Ki saluki_components::sources::dogstatsd::handle_frame::hccb05cbc3099e6f9
[ = ] 0 [ = ] 0 TOTAL
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 49 out of 62 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
640877b to
00392c1
Compare
dbe5622 to
c268dd7
Compare
Co-authored-by: Travis Thieman <travis.thieman@gmail.com>
c268dd7 to
c4e321a
Compare
00392c1 to
85cc919
Compare
Regression Detector (Agent Data Plane)Regression Detector ResultsRun ID: bb6d4c1d-3ddb-4ac5-9f0d-ed1e23526dcd Baseline: d890d6b Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | otlp_ingest_logs_5mb_memory | memory utilization | +2.10 | [+1.66, +2.54] | 1 | (metrics) (profiles) (logs) |
| ➖ | otlp_ingest_logs_5mb_throughput | ingress throughput | +0.01 | [-0.12, +0.14] | 1 | (metrics) (profiles) (logs) |
| ➖ | otlp_ingest_logs_5mb_cpu | % cpu utilization | -0.41 | [-5.10, +4.29] | 1 | (metrics) (profiles) (logs) |
Fine details of change detection per experiment
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | dsd_uds_512kb_3k_contexts_cpu | % cpu utilization | +9.62 | [-50.60, +69.85] | 1 | (metrics) (profiles) (logs) |
| ➖ | dsd_uds_1mb_3k_contexts_cpu | % cpu utilization | +3.47 | [-52.10, +59.04] | 1 | (metrics) (profiles) (logs) |
| ➖ | otlp_ingest_logs_5mb_memory | memory utilization | +2.10 | [+1.66, +2.54] | 1 | (metrics) (profiles) (logs) |
| ➖ | dsd_uds_500mb_3k_contexts_throughput | ingress throughput | +0.66 | [+0.53, +0.78] | 1 | (metrics) (profiles) (logs) |
| ➖ | quality_gates_rss_idle | memory utilization | +0.66 | [+0.61, +0.70] | 1 | (metrics) (profiles) (logs) |
| ➖ | dsd_uds_100mb_3k_contexts_cpu | % cpu utilization | +0.56 | [-5.41, +6.53] | 1 | (metrics) (profiles) (logs) |
| ➖ | dsd_uds_1mb_3k_contexts_memory | memory utilization | +0.53 | [+0.36, +0.70] | 1 | (metrics) (profiles) (logs) |
| ➖ | otlp_ingest_traces_ottl_filtering_5mb_memory | memory utilization | +0.48 | [+0.14, +0.82] | 1 | (metrics) (profiles) (logs) |
| ➖ | quality_gates_rss_dsd_low | memory utilization | +0.25 | [+0.05, +0.44] | 1 | (metrics) (profiles) (logs) |
| ➖ | dsd_uds_500mb_3k_contexts_cpu | % cpu utilization | +0.19 | [-1.17, +1.54] | 1 | (metrics) (profiles) (logs) |
| ➖ | dsd_uds_100mb_3k_contexts_memory | memory utilization | +0.09 | [-0.09, +0.27] | 1 | (metrics) (profiles) (logs) |
| ➖ | dsd_uds_512kb_3k_contexts_memory | memory utilization | +0.06 | [-0.11, +0.23] | 1 | (metrics) (profiles) (logs) |
| ➖ | otlp_ingest_logs_5mb_throughput | ingress throughput | +0.01 | [-0.12, +0.14] | 1 | (metrics) (profiles) (logs) |
| ➖ | dsd_uds_10mb_3k_contexts_throughput | ingress throughput | +0.01 | [-0.13, +0.14] | 1 | (metrics) (profiles) (logs) |
| ➖ | otlp_ingest_traces_ottl_transform_5mb_throughput | ingress throughput | +0.00 | [-0.02, +0.02] | 1 | (metrics) (profiles) (logs) |
| ➖ | otlp_ingest_traces_ottl_filtering_5mb_throughput | ingress throughput | +0.00 | [-0.02, +0.02] | 1 | (metrics) (profiles) (logs) |
| ➖ | dsd_uds_1mb_3k_contexts_throughput | ingress throughput | -0.00 | [-0.06, +0.05] | 1 | (metrics) (profiles) (logs) |
| ➖ | otlp_ingest_traces_5mb_throughput | ingress throughput | -0.00 | [-0.02, +0.02] | 1 | (metrics) (profiles) (logs) |
| ➖ | dsd_uds_512kb_3k_contexts_throughput | ingress throughput | -0.00 | [-0.05, +0.05] | 1 | (metrics) (profiles) (logs) |
| ➖ | otlp_ingest_metrics_5mb_throughput | ingress throughput | -0.02 | [-0.15, +0.10] | 1 | (metrics) (profiles) (logs) |
| ➖ | dsd_uds_100mb_3k_contexts_throughput | ingress throughput | -0.03 | [-0.07, +0.00] | 1 | (metrics) (profiles) (logs) |
| ➖ | quality_gates_rss_dsd_heavy | memory utilization | -0.12 | [-0.25, +0.01] | 1 | (metrics) (profiles) (logs) |
| ➖ | quality_gates_rss_dsd_ultraheavy | memory utilization | -0.12 | [-0.25, +0.00] | 1 | (metrics) (profiles) (logs) |
| ➖ | otlp_ingest_traces_5mb_memory | memory utilization | -0.14 | [-0.39, +0.11] | 1 | (metrics) (profiles) (logs) |
| ➖ | dsd_uds_10mb_3k_contexts_memory | memory utilization | -0.20 | [-0.38, -0.01] | 1 | (metrics) (profiles) (logs) |
| ➖ | otlp_ingest_traces_ottl_transform_5mb_cpu | % cpu utilization | -0.22 | [-2.35, +1.91] | 1 | (metrics) (profiles) (logs) |
| ➖ | otlp_ingest_traces_ottl_filtering_5mb_cpu | % cpu utilization | -0.24 | [-2.69, +2.22] | 1 | (metrics) (profiles) (logs) |
| ➖ | otlp_ingest_metrics_5mb_cpu | % cpu utilization | -0.33 | [-8.66, +8.01] | 1 | (metrics) (profiles) (logs) |
| ➖ | otlp_ingest_traces_ottl_transform_5mb_memory | memory utilization | -0.38 | [-0.62, -0.14] | 1 | (metrics) (profiles) (logs) |
| ➖ | otlp_ingest_logs_5mb_cpu | % cpu utilization | -0.41 | [-5.10, +4.29] | 1 | (metrics) (profiles) (logs) |
| ➖ | dsd_uds_500mb_3k_contexts_memory | memory utilization | -0.57 | [-0.74, -0.41] | 1 | (metrics) (profiles) (logs) |
| ➖ | quality_gates_rss_dsd_medium | memory utilization | -0.59 | [-0.78, -0.40] | 1 | (metrics) (profiles) (logs) |
| ➖ | otlp_ingest_traces_5mb_cpu | % cpu utilization | -1.37 | [-3.63, +0.90] | 1 | (metrics) (profiles) (logs) |
| ➖ | dsd_uds_10mb_3k_contexts_cpu | % cpu utilization | -1.88 | [-32.83, +29.07] | 1 | (metrics) (profiles) (logs) |
| ➖ | otlp_ingest_metrics_5mb_memory | memory utilization | -4.97 | [-5.19, -4.74] | 1 | (metrics) (profiles) (logs) |
Bounds Checks: ✅ Passed
| perf | experiment | bounds_check_name | replicates_passed | observed_value | links |
|---|---|---|---|---|---|
| ✅ | quality_gates_rss_dsd_heavy | memory_usage | 10/10 | 111.60MiB ≤ 140MiB | (metrics) (profiles) (logs) |
| ✅ | quality_gates_rss_dsd_low | memory_usage | 10/10 | 33.88MiB ≤ 50MiB | (metrics) (profiles) (logs) |
| ✅ | quality_gates_rss_dsd_medium | memory_usage | 10/10 | 53.36MiB ≤ 75MiB | (metrics) (profiles) (logs) |
| ✅ | quality_gates_rss_dsd_ultraheavy | memory_usage | 10/10 | 167.03MiB ≤ 200MiB | (metrics) (profiles) (logs) |
| ✅ | quality_gates_rss_idle | memory_usage | 10/10 | 21.01MiB ≤ 40MiB | (metrics) (profiles) (logs) |
Explanation
Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%
Performance changes are noted in the perf column of each table:
- ✅ = significantly better comparison variant performance
- ❌ = significantly worse comparison variant performance
- ➖ = no significant change in performance
A regression test is an A/B test of target performance in a repeatable rig, where "performance" is measured as "comparison variant minus baseline variant" for an optimization goal (e.g., ingress throughput). Due to intrinsic variability in measuring that goal, we can only estimate its mean value for each experiment; we report uncertainty in that value as a 90.00% confidence interval denoted "Δ mean % CI".
For each experiment, we decide whether a change in performance is a "regression" -- a change worth investigating further -- if all of the following criteria are true:
-
Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.
-
Its 90.00% confidence interval "Δ mean % CI" does not contain zero, indicating that if our statistical model is accurate, there is at least a 90.00% chance there is a difference in performance between baseline and comparison variants.
-
Its configuration does not mark it "erratic".

Summary
As stated in the PR title.
Just replacing
e.g.in this one related to rules around abbreviations: https://developers.google.com/style/abbreviations#dont-useChange Type
How did you test this PR?
References
AGTMETRICS-400