Skip to content

chore(docs): remove hyphen in instances of 'ly-'#1284

Merged
tobz merged 4 commits into
mainfrom
tobz/docs-cleanup-vale-ly-hyphen
Mar 30, 2026
Merged

chore(docs): remove hyphen in instances of 'ly-'#1284
tobz merged 4 commits into
mainfrom
tobz/docs-cleanup-vale-ly-hyphen

Conversation

@tobz
Copy link
Copy Markdown
Member

@tobz tobz commented Mar 30, 2026

Summary

This PR removes hyphens between compound "ly" words, such as "consistently-sized": https://developers.google.com/style/hyphens#exceptions_2

Change Type

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

How did you test this PR?

References

AGTMETRICS-400

Copilot AI review requested due to automatic review settings March 30, 2026 19:23
@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/memory Memory bounds and memory management. area/observability Internal observability of ADP and Saluki. labels Mar 30, 2026
Copy link
Copy Markdown
Member Author

tobz commented Mar 30, 2026

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.

Pull request overview

Docs-only cleanup to remove hyphens in “ly-” compound adjectives across several Rust doc comments.

Changes:

  • Replace “statically-defined” → “statically defined”
  • Replace “lazily-initialized” / “dynamically-updated” / “newly-created” → unhyphenated forms
  • Replace “dynamically-sized” / “consistently-sized” → unhyphenated forms in buffer docs

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
lib/saluki-metrics/src/macros.rs Doc comment wording change to remove “-ly” hyphenation.
lib/saluki-io/src/net/util/retry/backoff.rs Doc comment wording change to remove “lazily-initialized” hyphenation.
lib/saluki-env/src/helpers/remote_agent/session.rs Doc comment wording change to remove “dynamically-updated” hyphenation.
lib/saluki-common/src/buf/chunked.rs Doc comment wording change to remove “-ly” hyphenation in buffer docs.
lib/memory-accounting/src/allocator.rs Doc comment wording change to remove “newly-created” hyphenation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread lib/saluki-common/src/buf/chunked.rs Outdated
use tokio::io::AsyncWrite;

/// A bytes buffer that write dynamically-sized payloads across multiple fixed-size chunks.
/// A bytes buffer that write dynamically sized payloads across multiple fixed-size chunks.
Copy link

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

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

Grammar: "A bytes buffer that write ..." should be "... that writes ..." to match the singular subject ("buffer").

Suggested change
/// A bytes buffer that write dynamically sized payloads across multiple fixed-size chunks.
/// A bytes buffer that writes dynamically sized payloads across multiple fixed-size chunks.

Copilot uses AI. Check for mistakes.
@tobz tobz added the type/chore Updates to dependencies or general "administrative" tasks necessary to maintain the codebase/repo. label Mar 30, 2026
@tobz tobz marked this pull request as ready for review March 30, 2026 19:26
@tobz tobz requested a review from a team as a code owner March 30, 2026 19:26
@tobz tobz force-pushed the tobz/vale-docs-cleanup-part-one-of-7-billion branch from d9c25bc to 9ccd994 Compare March 30, 2026 19:30
@tobz tobz force-pushed the tobz/docs-cleanup-vale-ly-hyphen branch from 62814a7 to 23cdce0 Compare March 30, 2026 19:30
@dd-octo-sts dd-octo-sts Bot removed the area/core Core functionality, event model, etc. label Mar 30, 2026
@pr-commenter
Copy link
Copy Markdown

pr-commenter Bot commented Mar 30, 2026

Binary Size Analysis (Agent Data Plane)

Target: 7d03456 (baseline) vs 23cdce0 (comparison) diff
Analysis Type: Stripped binaries (debug symbols excluded)
Baseline Size: 26.20 MiB
Comparison Size: 26.20 MiB
Size Change: +0 B (+0.00%)
Pass/Fail Threshold: +5%
Result: PASSED ✅

Changes by Module

Module File Size Symbols

Detailed Symbol Changes

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  [ = ]       0  [ = ]       0    TOTAL

@pr-commenter
Copy link
Copy Markdown

pr-commenter Bot commented Mar 30, 2026

Regression Detector (Agent Data Plane)

Regression Detector Results

Run ID: d6259169-293f-42af-8928-2acf1716170c

Baseline: 7d03456
Comparison: 23cdce0
Diff

Optimization Goals: ✅ No significant changes detected

Experiments ignored for regressions

Regressions in experiments with settings containing erratic: true are ignored.

perf experiment goal Δ mean % Δ mean % CI trials links
otlp_ingest_logs_5mb_throughput ingress throughput +0.01 [-0.11, +0.14] 1 (metrics) (profiles) (logs)
otlp_ingest_logs_5mb_cpu % cpu utilization -1.61 [-6.27, +3.05] 1 (metrics) (profiles) (logs)
otlp_ingest_logs_5mb_memory memory utilization -4.95 [-5.53, -4.38] 1 (metrics) (profiles) (logs)

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
dsd_uds_10mb_3k_contexts_cpu % cpu utilization +1.08 [-29.87, +32.02] 1 (metrics) (profiles) (logs)
dsd_uds_500mb_3k_contexts_throughput ingress throughput +0.78 [+0.66, +0.91] 1 (metrics) (profiles) (logs)
otlp_ingest_traces_ottl_transform_5mb_cpu % cpu utilization +0.70 [-1.45, +2.84] 1 (metrics) (profiles) (logs)
quality_gates_rss_idle memory utilization +0.56 [+0.52, +0.61] 1 (metrics) (profiles) (logs)
quality_gates_rss_dsd_low memory utilization +0.51 [+0.31, +0.71] 1 (metrics) (profiles) (logs)
dsd_uds_500mb_3k_contexts_cpu % cpu utilization +0.38 [-0.99, +1.75] 1 (metrics) (profiles) (logs)
quality_gates_rss_dsd_medium memory utilization +0.24 [+0.05, +0.43] 1 (metrics) (profiles) (logs)
otlp_ingest_traces_ottl_transform_5mb_memory memory utilization +0.24 [-0.01, +0.48] 1 (metrics) (profiles) (logs)
dsd_uds_512kb_3k_contexts_memory memory utilization +0.17 [-0.01, +0.36] 1 (metrics) (profiles) (logs)
otlp_ingest_logs_5mb_throughput ingress throughput +0.01 [-0.11, +0.14] 1 (metrics) (profiles) (logs)
dsd_uds_1mb_3k_contexts_throughput ingress throughput +0.00 [-0.05, +0.06] 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_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_traces_ottl_filtering_5mb_throughput ingress throughput -0.00 [-0.02, +0.02] 1 (metrics) (profiles) (logs)
dsd_uds_10mb_3k_contexts_throughput ingress throughput -0.00 [-0.14, +0.13] 1 (metrics) (profiles) (logs)
dsd_uds_100mb_3k_contexts_throughput ingress throughput -0.01 [-0.04, +0.02] 1 (metrics) (profiles) (logs)
quality_gates_rss_dsd_ultraheavy memory utilization -0.03 [-0.16, +0.11] 1 (metrics) (profiles) (logs)
dsd_uds_100mb_3k_contexts_memory memory utilization -0.04 [-0.22, +0.15] 1 (metrics) (profiles) (logs)
otlp_ingest_metrics_5mb_throughput ingress throughput -0.05 [-0.18, +0.09] 1 (metrics) (profiles) (logs)
dsd_uds_500mb_3k_contexts_memory memory utilization -0.08 [-0.25, +0.09] 1 (metrics) (profiles) (logs)
otlp_ingest_traces_5mb_memory memory utilization -0.09 [-0.35, +0.16] 1 (metrics) (profiles) (logs)
dsd_uds_10mb_3k_contexts_memory memory utilization -0.13 [-0.32, +0.06] 1 (metrics) (profiles) (logs)
dsd_uds_1mb_3k_contexts_memory memory utilization -0.17 [-0.34, +0.01] 1 (metrics) (profiles) (logs)
otlp_ingest_metrics_5mb_cpu % cpu utilization -0.33 [-7.54, +6.88] 1 (metrics) (profiles) (logs)
dsd_uds_100mb_3k_contexts_cpu % cpu utilization -0.37 [-6.48, +5.75] 1 (metrics) (profiles) (logs)
otlp_ingest_traces_ottl_filtering_5mb_memory memory utilization -0.37 [-0.71, -0.03] 1 (metrics) (profiles) (logs)
quality_gates_rss_dsd_heavy memory utilization -0.38 [-0.51, -0.24] 1 (metrics) (profiles) (logs)
otlp_ingest_traces_5mb_cpu % cpu utilization -0.88 [-3.06, +1.29] 1 (metrics) (profiles) (logs)
otlp_ingest_traces_ottl_filtering_5mb_cpu % cpu utilization -1.24 [-3.76, +1.28] 1 (metrics) (profiles) (logs)
otlp_ingest_logs_5mb_cpu % cpu utilization -1.61 [-6.27, +3.05] 1 (metrics) (profiles) (logs)
dsd_uds_512kb_3k_contexts_cpu % cpu utilization -2.70 [-58.38, +52.98] 1 (metrics) (profiles) (logs)
otlp_ingest_metrics_5mb_memory memory utilization -3.58 [-3.84, -3.32] 1 (metrics) (profiles) (logs)
dsd_uds_1mb_3k_contexts_cpu % cpu utilization -3.82 [-57.56, +49.91] 1 (metrics) (profiles) (logs)
otlp_ingest_logs_5mb_memory memory utilization -4.95 [-5.53, -4.38] 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 112.50MiB ≤ 140MiB (metrics) (profiles) (logs)
quality_gates_rss_dsd_low memory_usage 10/10 33.80MiB ≤ 50MiB (metrics) (profiles) (logs)
quality_gates_rss_dsd_medium memory_usage 10/10 53.43MiB ≤ 75MiB (metrics) (profiles) (logs)
quality_gates_rss_dsd_ultraheavy memory_usage 10/10 168.90MiB ≤ 200MiB (metrics) (profiles) (logs)
quality_gates_rss_idle memory_usage 10/10 21.16MiB ≤ 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:

  1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.

  2. 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.

  3. Its configuration does not mark it "erratic".

Base automatically changed from tobz/vale-docs-cleanup-part-one-of-7-billion to main March 30, 2026 20:02
@tobz tobz merged commit d890d6b into main Mar 30, 2026
58 checks passed
@tobz tobz deleted the tobz/docs-cleanup-vale-ly-hyphen branch March 30, 2026 20:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/config Configuration. area/io General I/O and networking. area/memory Memory bounds and memory management. area/observability Internal observability of ADP and Saluki. 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