Skip to content

Commit c0315d0

Browse files
committed
chore(docs): more vale cleanup (ly hyphens, optional plurals, exclamations, etc)
1 parent 2bd3d88 commit c0315d0

46 files changed

Lines changed: 76 additions & 76 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

bin/agent-data-plane/src/components/ottl_transform_processor/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ impl OttlTransformConfiguration {
4949

5050
#[async_trait]
5151
impl SynchronousTransformBuilder for OttlTransformConfiguration {
52-
/// Builds the OTTL Transform transform from the current configuration.
52+
/// Builds the OTTL `Transform` from the current configuration.
5353
///
5454
/// Registers the `set` editor function, parses each trace statement, and returns
5555
/// the transform. Statements may be editor calls like `set(attributes["key"], "value")`

bin/correctness/panoramic/src/cli.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ pub struct RunCommand {
2626
#[argh(option, short = 'd')]
2727
pub test_dirs: Vec<PathBuf>,
2828

29-
/// run only specific test(s) by name (comma-separated)
29+
/// run only specific tests by name (comma-separated)
3030
#[argh(option, short = 't')]
3131
pub tests: Option<String>,
3232

bin/correctness/panoramic/src/config.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ pub enum AssertionConfig {
254254
},
255255
}
256256

257-
/// Which log stream(s) to check.
257+
/// Which log streams to check.
258258
#[derive(Clone, Debug, Default, Deserialize)]
259259
#[serde(rename_all = "lowercase")]
260260
pub enum LogStream {

docs/agent-data-plane/releasing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The release process for ADP roughly looks like this:
3030
the release notes. (above the auto-generated `What's Changed` section)
3131
- Click `Publish release`.
3232
- Go to the [GitLab CI pipelines dashboard](https://gitlab.ddbuild.io/DataDog/saluki/-/pipelines) for the repository and
33-
find the pipeline that was triggered for the newly-created Git tag. It may take a minute or two for the repository
33+
find the pipeline that was triggered for the newly created Git tag. It may take a minute or two for the repository
3434
sync and pipeline creation to occur.
3535
- The pipeline should progress through the `test`, `build`, `correctness`, and `release` stages without issue.
3636
- Once all stages have completed, the `release` stage will have a number of blocked jobs: standalone image publishing,
@@ -40,7 +40,7 @@ The release process for ADP roughly looks like this:
4040
- Once triggered, they should run to completion.
4141
- Once complete, you should be able to navigate to a public container image registry that we use, such as [Docker
4242
Hub](https://hub.docker.com/r/datadog/agent-data-plane/tags), and find the resulting images: if the tag was `0.2.0`,
43-
you should be able to see a recently-published image with a tag that looks like `0.2.0` and `0.2.0-fips`.
43+
you should be able to see a recently published image with a tag that looks like `0.2.0` and `0.2.0-fips`.
4444
- Post a release announcement in the `#agent-data-plane` Slack channel
4545
in the following format:
4646
```

docs/development/common-language.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ processes. You're encouraged to read the RFC, but here's a quick rundown:
2020
- **MAY**/**OPTIONAL**: this is legitimately optional ("dealer's choice")
2121

2222
Like RFC 2119 mentions, these should be used sparingly and only when necessary to clarify expectations... so if you see
23-
them, pay attention!
23+
them, pay attention.

docs/development/contributing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing
22

3-
First of all, thank you for looking to contribute to Saluki! We're excited to have you here.
3+
First of all, thank you for looking to contribute to Saluki. We're excited to have you here.
44

55
This document covers some simple guidelines for both filing issues and contributing code to the project.
66

@@ -16,7 +16,7 @@ you can.
1616
## Pull requests
1717

1818
You've gotten to the point of working on a fix or a new feature, and now you want to contribute that upstream. This is
19-
awesome!
19+
awesome.
2020

2121
We strive for a high level of quality in terms of pull requests, and this guide is meant to help you understand what we
2222
expect from a PR so that you're not surprised during the review process.
@@ -84,9 +84,9 @@ ready for actual reviews.
8484

8585
#### Before the first PR review
8686

87-
Before the first PR review, meaningful commits are best: logically-encapsulated commits help the reviews go quicker and
87+
Before the first PR review, meaningful commits are best: logically encapsulated commits help the reviews go quicker and
8888
make the job for the reviewer easier. Conflicts with `main` can be resolved with a `git rebase origin/main` and a force
89-
push if it makes future review(s) easier.
89+
push if it makes future reviews easier.
9090

9191
#### After the first review
9292

docs/development/style-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ When documenting performance, memory, or design trade-offs, be explicit about wh
311311
- **Name both sides**: "This represents a trade-off between throughput and memory usage"
312312
- **Quantify when possible**: "Approximately 150–200 bytes per context based on typical metric names and tags"
313313
- **Acknowledge variability**: "The optimal value is workload-dependent"
314-
- **Provide guidance**: "A good starting point is 1MB per 5000 unique contexts"
314+
- **Provide guidance**: "A good starting point is 1 MB per 5000 unique contexts"
315315

316316
Example:
317317

docs/reference/adrs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ Adding a new ADR is a straightforward process:
2020
<a :href="record.url" v-html="record.pretty_title" />
2121
</li>
2222
</ul>
23-
<p v-else><b>No ADRs defined yet!</b></p>
23+
<p v-else><b>No ADRs defined yet.</b></p>

docs/reference/proposals/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ Adding a new proposal is a straightforward process:
2020
<a :href="record.url" v-html="record.pretty_title" />
2121
</li>
2222
</ul>
23-
<p v-else><b>No proposals defined yet!</b></p>
23+
<p v-else><b>No proposals defined yet.</b></p>

lib/datadog-agent-commons/src/ipc/config.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ pub struct RemoteAgentClientConfiguration {
143143

144144
/// Maximum message size for gRPC messages.
145145
///
146-
/// Defaults to `128 * 1024 * 1024` (128MB).
146+
/// Defaults to `128 * 1024 * 1024` (128 MB).
147147
#[serde(
148148
rename = "agent_ipc_grpc_max_message_size",
149149
default = "default_grpc_max_message_size"

0 commit comments

Comments
 (0)