chore(docs): improve technical terms detection#1665
Merged
gh-worker-dd-mergequeue-cf854d[bot] merged 2 commits intoMay 15, 2026
Merged
chore(docs): improve technical terms detection#1665gh-worker-dd-mergequeue-cf854d[bot] merged 2 commits into
gh-worker-dd-mergequeue-cf854d[bot] merged 2 commits into
Conversation
dd-octo-sts
Bot
added
area/core
Binary Size Analysis (Agent Data Plane)Target: 5ff8571 (baseline) vs 724ed7c (comparison) diff
|
| Module | File Size | Symbols |
|---|---|---|
anon.210c875deb8dcc7f96e2cfcbd9e565c7.25.llvm.17043991802426554815 |
-1.52 KiB | 1 |
anon.629b3bab0e41ad290866ca5ba45c0b0b.161.llvm.8732981799842608513 |
+1.52 KiB | 1 |
anon.febac4b1f65489d1d095e5b52317d45d.754.llvm.12026364410698552598 |
+1002 B | 1 |
anon.0f55d6679d075c395825a3b729bced71.416.llvm.13082800132604442316 |
-1001 B | 1 |
anon.2692365f0ce19c4890563cf39fbcafef.130.llvm.16187319478245569968 |
+756 B | 1 |
anon.b017a393807e1cdcd2bb5d74258d1ba8.143.llvm.858138160735126855 |
-755 B | 1 |
anon.febac4b1f65489d1d095e5b52317d45d.660.llvm.12026364410698552598 |
+541 B | 1 |
anon.5328b319c7beeefbf9fd3b07a11f0d7f.930.llvm.10055402123061084682 |
-540 B | 1 |
anon.ff90be7beb779e82f8922294e8fd6b78.290.llvm.4230509545864781107 |
+526 B | 1 |
anon.febac4b1f65489d1d095e5b52317d45d.620.llvm.9552582874760553218 |
-525 B | 1 |
anon.686bb57a20204b7af418be9a664b745b.1069.llvm.17510674805277077233 |
+464 B | 1 |
anon.686bb57a20204b7af418be9a664b745b.1069.llvm.16705991536037052993 |
-464 B | 1 |
anon.210c875deb8dcc7f96e2cfcbd9e565c7.776.llvm.17043991802426554815 |
-459 B | 1 |
anon.59ffbd4896f987ea9baa4f62ea551b70.259.llvm.12831752631567338469 |
+458 B | 1 |
anon.df9836059b19df5c825eb2ca360d4927.1086.llvm.14325120973772989477 |
+453 B | 1 |
anon.856f29a1542878aca71aaff03c79625f.1271.llvm.5073426850405053702 |
-451 B | 1 |
anon.ac617f3864ec8dd4b6e969b9e5e3913f.456.llvm.16344064618619055852 |
-401 B | 1 |
anon.21d5539572a42ad38e013a9af051c05a.29.llvm.4361819659546973486 |
+400 B | 1 |
anon.21d5539572a42ad38e013a9af051c05a.244.llvm.12395586115399624184 |
-396 B | 1 |
anon.21d5539572a42ad38e013a9af051c05a.244.llvm.4361819659546973486 |
+395 B | 1 |
Detailed Symbol Changes
FILE SIZE VM SIZE
-------------- --------------
[NEW] +2.01Ki [NEW] +61 core::ptr::drop_in_place<std::sync::poison::PoisonError<std::sync::poison::rwlock::RwLockReadGuard<quick_cache::shard::CacheShard<saluki_context::hash::ContextKey,saluki_context::context::Context,saluki_common::cache::weight::WrappedWeighter<saluki_common::cache::weight::ItemCountWeighter>,saluki_common::hash::NoopU64BuildHasher,saluki_common::cache::expiry::ExpiryCapableLifecycle<saluki_context::hash::ContextKey>,alloc::sync::Arc<quick_cache::sync_placeholder::Placeholder<saluki_context::context::Context>>>>>>::h013999c9f026494e
[NEW] +1.52Ki [NEW] +22 anon.629b3bab0e41ad290866ca5ba45c0b0b.161.llvm.8732981799842608513
[NEW] +1002 [NEW] +91 anon.febac4b1f65489d1d095e5b52317d45d.754.llvm.12026364410698552598
[NEW] +858 [NEW] +562 quick_cache::shard::CacheShard<Key,Val,We,B,L,Plh>::search::h78b75a820b6ff69e
[NEW] +788 [NEW] +177 core::ptr::drop_in_place<otlp_protos::otlp_include::opentelemetry::proto::collector::trace::v1::ExportTraceServiceResponse>::h07cbbca5b7000bbb
[NEW] +756 [NEW] +117 anon.2692365f0ce19c4890563cf39fbcafef.130.llvm.16187319478245569968
[NEW] +573 [NEW] +69 _<T as serde_core::de::Expected>::fmt::h9abc6c773baa54a3
[NEW] +541 [NEW] +84 anon.febac4b1f65489d1d095e5b52317d45d.660.llvm.12026364410698552598
[NEW] +526 [NEW] +72 anon.ff90be7beb779e82f8922294e8fd6b78.290.llvm.4230509545864781107
+153% +507 +100% +177 core::ptr::drop_in_place<core::option::Option<alloc::string::String>>::h33dc253eebc84015
[DEL] -508 [DEL] -177 core::ptr::drop_in_place<core::result::Result<bytesize::ByteSize,alloc::string::String>>::hc740f96b93406a7a
[DEL] -525 [DEL] -72 anon.febac4b1f65489d1d095e5b52317d45d.620.llvm.9552582874760553218
[DEL] -540 [DEL] -84 anon.5328b319c7beeefbf9fd3b07a11f0d7f.930.llvm.10055402123061084682
[DEL] -553 [DEL] -53 _<T as serde_core::de::Expected>::fmt::h835dfb66a46fcfd4
-0.1% -704 -0.0% -16 [2590 Others]
[DEL] -755 [DEL] -117 anon.b017a393807e1cdcd2bb5d74258d1ba8.143.llvm.858138160735126855
[DEL] -791 [DEL] -177 core::ptr::drop_in_place<otlp_protos::otlp_include::opentelemetry::proto::collector::metrics::v1::ExportMetricsServiceResponse>::h3c2606a08c4fe47d
[DEL] -856 [DEL] -562 quick_cache::shard::CacheShard<Key,Val,We,B,L,Plh>::search::h532a53c2d1c61f48
[DEL] -1001 [DEL] -91 anon.0f55d6679d075c395825a3b729bced71.416.llvm.13082800132604442316
[DEL] -1.52Ki [DEL] -22 anon.210c875deb8dcc7f96e2cfcbd9e565c7.25.llvm.17043991802426554815
[DEL] -2.01Ki [DEL] -61 core::ptr::drop_in_place<std::sync::poison::PoisonError<std::sync::poison::rwlock::RwLockReadGuard<quick_cache::shard::CacheShard<alloc::string::String,saluki_components::sources::otlp::metrics::cache::Extrema,saluki_common::cache::weight::WrappedWeighter<saluki_common::cache::weight::ItemCountWeighter>,foldhash::quality::RandomState,saluki_common::cache::expiry::ExpiryCapableLifecycle<alloc::string::String>,alloc::sync::Arc<quick_cache::sync_placeholder::Placeholder<saluki_components::sources::otlp::metrics::cache::Extrema>>>>>>::h4090863bd0ef0a8b
-0.0% -688 [ = ] 0 TOTAL
tobz
added
the
type/chore
Regression Detector (Agent Data Plane)Run ID: Optimization Goals: ✅ No significant changes detectedFine details of change detection per experiment (35)Experiments configured
Bounds Checks: ✅ Passed (5)
ExplanationA 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 ( |
jszwedko
approved these changes
May 15, 2026
gh-worker-dd-devflow-36fce6
Bot
added
mergequeue-status: queued
mergequeue-status: in_progress
and removed
mergequeue-status: queued
labels
gh-worker-dd-devflow-36fce6
Bot
added
mergequeue-status: done
and removed
mergequeue-status: in_progress
labels
dd-octo-sts Bot
pushed a commit
that referenced
this pull request
May 15, 2026
## Summary This PR fixes our Vale configuration around technical terms/acronyms to avoid false positives and improve coverage. Prior to this PR, we were using two style rules, from the Vale and Google style plugins, that were conflicting with each other and also just not doing exactly what we wanted: - `Vale.Terms` was using our technical vocabulary files and getting confused, thinking that legitimately cased acronyms like `TCP` were invalid, because the vocabulary listed it as `tcp` (which is intentional, as it's meant to be lowercase in order to drive _spellchecking_) - `Google.Acronyms` is better, but it primarily functions to check for usages of acronyms that aren't properly introduced (for example, with something like `Full Name Of Thing (FNOT)`) and that's just not relevant for many of our acronyms, which are used in doc comments, not full documents being read by an unfamiliar audience This PR disables those two style rules, and updates our own `Saluki.Terms` style rule to add more acronyms/technical terms that are relevant to Saluki and ADP. We've also fixed the identified issues from our `Saluki.Terms` style rule as part of this PR. ## Change Type - [ ] Bug fix - [ ] New feature - [x] Non-functional (chore, refactoring, docs) - [ ] Performance ## How did you test this PR? - Ran `make check-docs` before and after and verified that there were no more violations for the `Vale.Terms`, `Google.Acronyms`, or `Saluki.Terms` rules. - `make check-clippy` passes cleanly. ## References N/A Co-authored-by: jesse.szwedko <jesse.szwedko@datadoghq.com> efb3648
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR fixes our Vale configuration around technical terms/acronyms to avoid false positives and improve coverage.
Prior to this PR, we were using two style rules, from the Vale and Google style plugins, that were conflicting with each other and also just not doing exactly what we wanted:
Vale.Termswas using our technical vocabulary files and getting confused, thinking that legitimately cased acronyms likeTCPwere invalid, because the vocabulary listed it astcp(which is intentional, as it's meant to be lowercase in order to drive spellchecking)Google.Acronymsis better, but it primarily functions to check for usages of acronyms that aren't properly introduced (for example, with something likeFull Name Of Thing (FNOT)) and that's just not relevant for many of our acronyms, which are used in doc comments, not full documents being read by an unfamiliar audienceThis PR disables those two style rules, and updates our own
Saluki.Termsstyle rule to add more acronyms/technical terms that are relevant to Saluki and ADP. We've also fixed the identified issues from ourSaluki.Termsstyle rule as part of this PR.Change Type
How did you test this PR?
make check-docsbefore and after and verified that there were no more violations for theVale.Terms,Google.Acronyms, orSaluki.Termsrules.make check-clippypasses cleanly.References
N/A