chore(docs): replace latin abbrevations#1663
Merged
Merged
Conversation
dd-octo-sts
Bot
added
area/core
Member
Author
This stack of pull requests is managed by Graphite. Learn more about stacking. |
4 tasks
tobz
added
the
type/chore
There was a problem hiding this comment.
Pull request overview
This PR updates rustdoc and Markdown documentation across the Saluki codebase to satisfy the Vale Google.Latin style rule by replacing Latin abbreviations like “e.g.” / “i.e.” with clearer phrasing.
Changes:
- Replace “e.g.” with “for example” in code/docs comments and documentation.
- Replace “i.e.” with “that is” in code comments.
- Apply these edits across multiple crates and docs to eliminate the corresponding Vale violations.
Reviewed changes
Copilot reviewed 28 out of 28 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| lib/saluki-io/src/net/unix/mod.rs | Replace “i.e.” with “that is” in Unix socket rustdoc. |
| lib/saluki-core/src/runtime/shutdown.rs | Replace “e.g.” with “for example” in shutdown rustdoc. |
| lib/saluki-context/src/context.rs | Replace “e.g.” with “for example” in context/tag-set rustdoc. |
| lib/saluki-config/src/space_separated.rs | Replace “e.g.” with “for example” in module docs. |
| lib/saluki-config/src/lib.rs | Replace “e.g.” with “for example” in loader/testing docs. |
| lib/saluki-components/src/sources/dogstatsd/replay/capture_api.rs | Replace “e.g.” with “for example” in API struct field docs. |
| lib/saluki-components/src/sources/dogstatsd/mod.rs | Replace “e.g.” with “for example” in config docs and a test comment. |
| lib/saluki-components/src/config.rs | Replace “e.g.” with “for example” in env remapper docs. |
| lib/saluki-components/src/config_registry/test_support.rs | Replace “i.e.”/“e.g.” with plain language in test-support docs/messages. |
| lib/saluki-components/src/config_registry/mod.rs | Replace “e.g.” with “for example” in schema/annotation rustdoc. |
| lib/saluki-components/src/config_registry/datadog/forwarder.rs | Replace “e.g.” with “for example” in annotation docs. |
| lib/saluki-components/src/common/datadog/proxy.rs | Replace “e.g.” with “for example” in proxy/no_proxy documentation. |
| lib/saluki-components/src/common/datadog/obfuscation.rs | Replace “e.g.” with “for example” in obfuscation docs. |
| lib/saluki-common/src/hash.rs | Replace “e.g.” with “for example” in hasher docs. |
| lib/saluki-app/src/logging/mod.rs | Replace “e.g.” with “for example” in logging docs. |
| lib/saluki-app/src/logging/config.rs | Replace “e.g.” with “for example” in logging config docs. |
| lib/memory-accounting/src/limiter.rs | Replace “i.e.” with “that is” in limiter docs. |
| docs/reference/adrs/_template.md | Replace “e.g.” with “for example” in ADR template prose. |
| docs/development/testing.md | Replace “e.g.” with “for example” in testing docs. |
| docs/agent-data-plane/releasing.md | Replace “e.g.” with “for example” in release instructions. |
| docs/agent-data-plane/configuration/dogstatsd.md | Replace “e.g.” with “for example” in DogStatsD config docs. |
| bin/correctness/stele/src/metrics.rs | Replace “e.g.” with “for example” in metrics parsing docs. |
| bin/correctness/panoramic/src/test.rs | Replace “e.g.” with “for example” in test trait docs. |
| bin/correctness/panoramic/src/events.rs | Replace “e.g.” with “for example” in event enum docs. |
| bin/correctness/panoramic/src/config.rs | Replace “e.g.” with “for example” in config docs. |
| bin/correctness/panoramic/src/assertions/file_contains.rs | Replace “e.g.” with “for example” in assertion helper docs. |
| bin/correctness/millstone/src/config.rs | Replace “e.g.” with “for example” in target address docs. |
| bin/agent-data-plane/src/components/ottl_transform_processor/mod.rs | Replace “e.g.” with “for example” in OTTL transform docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Decision Outcome | ||
|
|
||
| Chosen option: "(option here)", because [justification. e.g., only option which meets all requirements, etc]. | ||
| Chosen option: "(option here)", because [justification. for example, only option which meets all requirements, etc]. |
Member
Author
There was a problem hiding this comment.
Ignoring for now because it's a template file, not actual content.
| ## Problem Statement | ||
|
|
||
| Begin with the problem statement, e.g., in free form using two to three sentences or in the form of an illustrative story. You may want to articulate the problem in form of a question and add links to collaboration boards or issue management systems. | ||
| Begin with the problem statement, for example, in free form using two to three sentences or in the form of an illustrative story. You may want to articulate the problem in form of a question and add links to collaboration boards or issue management systems. |
Member
Author
There was a problem hiding this comment.
True, because I misapplied some non-emdash changes to these files when tweaking them by hand... but I don't care enough to undo those non-emdash changes.
Binary Size Analysis (Agent Data Plane)Target: eaec791 (baseline) vs 5c4818a (comparison) diff
|
| Module | File Size | Symbols |
|---|---|---|
anon.17679c6efdc3f61299a067e3378f85c3.23.llvm.267345320671486619 |
-3.81 KiB | 1 |
anon.02bab6cd09c6871374e9d894c5ace985.9.llvm.10924540860055184880 |
+3.81 KiB | 1 |
anon.14b6b5c05f82f1bad9a3c99350adeb19.162.llvm.9281911275970552428 |
+3.15 KiB | 1 |
anon.c1c7ec8ec680e4785be08d066b5ec12c.2.llvm.657345546224115985 |
-3.15 KiB | 1 |
anon.8d8811c38c78989b07412358014ad95b.2.llvm.17737639912621458350 |
+2.91 KiB | 1 |
anon.7a1e67daf0a5471e84cac9841320bef2.11.llvm.15931891257474914529 |
-2.91 KiB | 1 |
anon.faad0b0ef688abfbc149208da5014c39.14.llvm.10066409204066882605 |
+1.52 KiB | 1 |
anon.c82e3ec55184c793df19ba4a327263bc.73.llvm.7229448801209298649 |
-1.52 KiB | 1 |
std |
+1.47 KiB | 32 |
core |
-1.43 KiB | 1055 |
anon.96c59221b5107dff7eaf5dab1da11e49.69.llvm.14565390076890238157 |
-1.34 KiB | 1 |
anon.96c59221b5107dff7eaf5dab1da11e49.69.llvm.16227409512847329245 |
+1.34 KiB | 1 |
anon.f3ad753cf0d9b73494dbe89aaea39df1.172.llvm.8334134140528354116 |
+1.32 KiB | 1 |
anon.1fe68cbddbd7be3d3efdb1444e7a5632.0.llvm.8454770004358052377 |
-1.32 KiB | 1 |
anon.cef2c965820659cc217e63c0fca83ae7.45.llvm.2267218659918062762 |
-1.23 KiB | 1 |
anon.9834cb516f6c34eadf87c0fdbdf724a2.822.llvm.6564797494820481706 |
+1.23 KiB | 1 |
anon.9d439f79226dfe45744a1b4bd164e563.650.llvm.16855916406314449080 |
-1.15 KiB | 1 |
anon.9d439f79226dfe45744a1b4bd164e563.650.llvm.15573869896550589999 |
+1.15 KiB | 1 |
anon.ee818850ff3b5ddd1c04af47d096974f.1479.llvm.1680541874418991595 |
+1.11 KiB | 1 |
anon.3f05685b4ab378e80ac94cf74ba48ff8.77.llvm.9723814408589241898 |
-1.11 KiB | 1 |
Detailed Symbol Changes
FILE SIZE VM SIZE
-------------- --------------
[NEW] +3.81Ki [NEW] +16 anon.02bab6cd09c6871374e9d894c5ace985.9.llvm.10924540860055184880
[NEW] +3.15Ki [NEW] +74 anon.14b6b5c05f82f1bad9a3c99350adeb19.162.llvm.9281911275970552428
[NEW] +2.91Ki [NEW] +2 anon.8d8811c38c78989b07412358014ad95b.2.llvm.17737639912621458350
[NEW] +2.41Ki [NEW] +458 core::ptr::drop_in_place<core::iter::adapters::map::Map<std::collections::hash::map::IntoIter<axum::routing::RouteId,axum::routing::Endpoint<saluki_components::destinations::dsd_stats::DogStatsDAPIHandlerState>>,axum::routing::path_router::PathRouter<saluki_components::destinations::dsd_stats::DogStatsDAPIHandlerState,_>::with_state<$LP$$RP$>::{{closure}}>>::h0082bd76185b0346
[NEW] +2.01Ki [NEW] +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>>>>>>::h1fb04ef4c3082095
[NEW] +1.63Ki [NEW] +1.39Ki tokio::sync::broadcast::Shared<T>::notify_rx::h5d4a78a127055a4f
[NEW] +1.61Ki [NEW] +47 _<http_body_util::combinators::map_err::MapErr<B,F> as http_body::Body>::size_hint::h59aa281810bdc839
[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::read<&std::path::Path>::{{closure}}::{{closure}}>,tokio::runtime::blocking::schedule::BlockingSchedule>>>::h3a25f44962f2aa6c
[NEW] +1.52Ki [NEW] +22 anon.faad0b0ef688abfbc149208da5014c39.14.llvm.10066409204066882605
[NEW] +1.42Ki [NEW] +33 core::ptr::drop_in_place<http_body_util::combinators::map_err::MapErr<tonic::codec::encode::EncodeBody<tonic_prost::codec::ProstEncoder<datadog_protos::agent_include::datadog::remoteagent::v1::RefreshRemoteAgentRequest>,tokio_stream::stream_ext::map::Map<tokio_stream::once::Once<datadog_protos::agent_include::datadog::remoteagent::v1::RefreshRemoteAgentRequest>,core::result::Result<datadog_protos::agent_include::datadog::remoteagent::v1::RefreshRemoteAgentRequest,tonic::status::Status>::Ok>>,tonic::status::Status::map_error<tonic::status::Status>>>::h64718a07111df098
-0.0% -153 [ = ] 0 [6770 Others]
[DEL] -1.41Ki [DEL] -33 core::ptr::drop_in_place<http_body_util::combinators::map_err::MapErr<tonic::codec::encode::EncodeBody<tonic_prost::codec::ProstEncoder<containerd_protos::containerd_include::containerd::services::namespaces::v1::ListNamespacesRequest>,tokio_stream::stream_ext::map::Map<tokio_stream::once::Once<containerd_protos::containerd_include::containerd::services::namespaces::v1::ListNamespacesRequest>,core::result::Result<containerd_protos::containerd_include::containerd::services::namespaces::v1::ListNamespacesRequest,tonic::status::Status>::Ok>>,tonic::status::Status::map_error<tonic::status::Status>>>::h227c4a954b492967
[DEL] -1.52Ki [DEL] -22 anon.c82e3ec55184c793df19ba4a327263bc.73.llvm.7229448801209298649
[DEL] -1.60Ki [DEL] -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>>>::h4a735f90f04d95b9
[DEL] -1.60Ki [DEL] -47 _<http_body_util::combinators::map_err::MapErr<B,F> as http_body::Body>::size_hint::hf6b5ce1cf0ffd1d7
[DEL] -1.63Ki [DEL] -1.39Ki tokio::sync::broadcast::Shared<T>::notify_rx::h6d7c356c22414e1b
[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::NumberCounter,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::NumberCounter>>>>>>::hae10bd403cfad043
[DEL] -2.41Ki [DEL] -458 core::ptr::drop_in_place<core::iter::adapters::map::Map<std::collections::hash::map::IntoIter<axum::routing::RouteId,axum::routing::Endpoint<saluki_components::destinations::dsd_stats::DogStatsDAPIHandlerState>>,axum::routing::path_router::PathRouter<saluki_components::destinations::dsd_stats::DogStatsDAPIHandlerState,_>::with_state<$LP$$RP$>::{{closure}}>>::h4ac8cd2d0d6dfbc8
[DEL] -2.91Ki [DEL] -2 anon.7a1e67daf0a5471e84cac9841320bef2.11.llvm.15931891257474914529
[DEL] -3.15Ki [DEL] -74 anon.c1c7ec8ec680e4785be08d066b5ec12c.2.llvm.657345546224115985
[DEL] -3.81Ki [DEL] -16 anon.17679c6efdc3f61299a067e3378f85c3.23.llvm.267345320671486619
-0.0% -144 [ = ] 0 TOTAL
jszwedko
approved these changes
May 15, 2026
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 ( |
Base automatically changed from
tobz/vale-docs-fixes-part-one-of-8-million
to
main
May 15, 2026 18:08
tobz
force-pushed
the
tobz/docs-cleanup-latin-abbrevations
branch
from
18f21dd to
5c4818a
Compare
4 tasks
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
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 all violations for the
Google.Latinstyle rule in Vale. Specifically, replacing Latin abbreviations (e.g.andi.e.) with straightforward language.This drops the number of Vale violations for the
Google.EmDashrule from 57 to zero.Change Type
How did you test this PR?
make check-docsbefore and after and verified the drop in violation count for theGoogle.Latinrule.make check-clippypasses cleanly.References
N/A