Skip to content

Commit 61d878c

Browse files
authored
Fix typos (#5766)
1 parent e31edf6 commit 61d878c

File tree

18 files changed

+35
-35
lines changed

18 files changed

+35
-35
lines changed

distribution/lambda/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,11 @@ pipenv install
4343
### Example stacks
4444

4545
Provided demonstration setups:
46-
- HDFS example data: index the the [HDFS
46+
- HDFS example data: index the [HDFS
4747
dataset](https://quickwit-datasets-public.s3.amazonaws.com/hdfs-logs-multitenants-10000.json)
4848
by triggering the Quickwit lambda manually.
4949
- Mock Data generator: start a mock data generator lambda that pushes mock JSON
50-
data every X minutes to S3. Those file trigger the Quickwit indexer lambda
50+
data every X minutes to S3. Those files trigger the Quickwit indexer lambda
5151
automatically.
5252

5353
### Deploy and run
@@ -56,7 +56,7 @@ The Makefile is a useful entrypoint to show how the Lambda deployment can used.
5656

5757
Configure your shell and AWS account:
5858
```bash
59-
# replace with you AWS account ID and preferred region
59+
# replace with your AWS account ID and preferred region
6060
export CDK_ACCOUNT=123456789
6161
export CDK_REGION=us-east-1
6262
make bootstrap
@@ -131,7 +131,7 @@ SEARCHER_API_KEY=my-at-least-20-char-long-key make deploy-mock-data
131131
> deployment, the key should be fetched from something like [AWS Secrets
132132
> Manager](https://docs.aws.amazon.com/cdk/v2/guide/get_secrets_manager_value.html).
133133
134-
Note that the response is always gzipped compressed, regardless the
134+
Note that the response is always gzipped compressed, regardless of the
135135
`Accept-Encoding` request header:
136136

137137
```bash

docs/configuration/index-config.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ The timezone name format specifier (`%Z`) is not supported currently.
225225
- `unix_timestamp`: parse float and integer numbers to Unix timestamps. Floating-point values are converted to timestamps expressed in seconds. Integer values are converted to Unix timestamps whose precision, determined in `seconds`, `milliseconds`, `microseconds`, or `nanoseconds`, is inferred from the number of input digits. Internally, datetimes are converted to UTC (if the time zone is specified) and stored as *i64* integers. As a result, Quickwit only supports timestamp values ranging from `Apr 13, 1972 23:59:55` to `Mar 16, 2242 12:56:31`.
226226

227227
:::warning
228-
Converting timestamps from float to integer values may occurs with a loss of precision.
228+
Converting timestamps from float to integer values may occur with a loss of precision.
229229
:::
230230

231231
When a `datetime` field is stored as a fast field, the `fast_precision` parameter indicates the precision used to truncate the values before encoding, which improves compression (truncation here means zeroing). The `fast_precision` parameter can take the following values: `seconds`, `milliseconds`, `microseconds`, or `nanoseconds`. It only affects what is stored in fast fields when a `datetime` field is marked as "fast". Finally, operations on `datetime` fast fields, e.g. via aggregations, need to be done at the nanosecond level.
@@ -365,7 +365,7 @@ fast:
365365
| `description` | Optional description for the field. | `None` |
366366
| `stored` | Whether value is stored in the document store | `true` |
367367
| `indexed` | Whether value is indexed | `true` |
368-
| `fast` | Whether value is stored in a fast field. The default behaviour for text in the JSON is to store the text unchanged. An normalizer can be configured via `normalizer: lowercase`. ([See normalizers](#description-of-available-normalizers)) for a list of available normalizers. | `false` |
368+
| `fast` | Whether value is stored in a fast field. The default behaviour for text in the JSON is to store the text unchanged. A normalizer can be configured via `normalizer: lowercase`. ([See normalizers](#description-of-available-normalizers)) for a list of available normalizers. | `false` |
369369
| `tokenizer` | **Only affects strings in the json object**. Name of the `Tokenizer`, choices between `raw`, `default`, `en_stem` and `chinese_compatible` | `raw` |
370370
| `record` | **Only affects strings in the json object**. Describes the amount of information indexed, choices between `basic`, `freq` and `position` | `basic` |
371371
| `expand_dots` | If true, json keys containing a `.` should be expanded. For instance, if `expand_dots` is set to true, `{"k8s.node.id": "node-2"}` will be indexed as if it was `{"k8s": {"node": {"id": "node2"}}}`. The benefit is that escaping the `.` will not be required at query time. In other words, `k8s.node.id:node2` will match the document. This does not impact the way the document is stored. | `true` |
@@ -418,7 +418,7 @@ field_mappings:
418418
#### concatenate
419419

420420
Quickwit supports mapping the content of multiple fields to a single one. This can be more efficient at query time than
421-
searching through dozens of `default_search_fields`. It also allow querying inside a json field without knowing the path
421+
searching through dozens of `default_search_fields`. It also allows querying inside a json field without knowing the path
422422
to the field being searched.
423423

424424
```yaml
@@ -438,7 +438,7 @@ At query time, concatenate fields don't support range queries.
438438
Only the following types are supported inside a concatenate field: text, bool, i64, u64, f64, json. Other types are rejected
439439
at index creation, or silently discarded during indexation if they are found inside a json field.
440440
Adding an object field to a concatenate field doesn't automatically add its subfields (yet).
441-
<!-- typing is made so it wouldn't be too hard do add, as well as things like params_* matching all fields which starts name with params_ , but the feature isn't implemented yet -->
441+
<!-- typing is made so it wouldn't be too hard to add, as well as things like params_* matching all fields which starts name with params_ , but the feature isn't implemented yet -->
442442
It isn't possible to add subfields from a json field to a concatenate field. For instance if `attributes` is a json field, it's not possible to add only `attributes.color` to a concatenate field.
443443

444444
For json fields and dynamic fields, the path is not indexed, only values are. For instance, given the following document:
@@ -507,7 +507,7 @@ When the `dynamic_mapping` is set as indexed (default), fields mapped through
507507
dynamic mode can be searched by targeting the path needed to access them from
508508
the root of the JSON object.
509509

510-
For instance, in a entirely schemaless settings, a minimal index configuration could be:
510+
For instance, in an entirely schemaless settings, a minimal index configuration could be:
511511

512512
```yaml
513513
version: 0.7

docs/internals/backward-compatibility.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ pub(crate) enum VersionedXXXXXX {
7979
- run the backward compatibility tests (see below)
8080
- for older versions, check the diff between the `xxx.expected.modified.json` files created and the matching `xxx.expected.json` files.
8181
If the changes are acceptable, replace the content of the `xxx.expected.json` files and commit them.
82-
- check the the `yyyy.json` that was created for the new version and commit it along with the `yyyy.expected.json` file (identical).
82+
- check the `yyyy.json` that was created for the new version and commit it along with the `yyyy.expected.json` file (identical).
8383
- possibly update the generation of the default XXXX instance used for regression. It is in the function `TestableForRegression::sample_for_regression`.
8484

8585

@@ -117,7 +117,7 @@ the CI will catch it.
117117

118118
#### Adding a new test case.
119119

120-
If the serialization format changes, an new version should be created and the unit test will
120+
If the serialization format changes, a new version should be created and the unit test will
121121
automatically add a new unit test generated from the sample tested objects.
122122
Concretely, it will just write two files `XXXX.json` and `XXXX.expected.json` for each model.
123123

docs/reference/aggregation.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_position: 30
55

66
An aggregation summarizes your data as statistics on buckets or metrics.
77

8-
Aggregations can provide answer to questions like:
8+
Aggregations can provide answers to questions like:
99

1010
- What is the average price of all sold articles?
1111
- How many errors with status code 500 do we have per day?
@@ -182,7 +182,7 @@ The returned format is currently fixed at `RFC3339`.
182182

183183
By default buckets are returned between the min and max value of the documents, including empty buckets. Setting `min_doc_count > 0` will filter empty buckets.
184184

185-
The value range of the buckets can bet extended via [`extended_bounds`](#extended_bounds) or limit the range via [`hard_bounds`](#hard_bounds).
185+
The value range of the buckets can be extended via [`extended_bounds`](#extended_bounds) or limit the range via [`hard_bounds`](#hard_bounds).
186186

187187
#### Example
188188

@@ -222,7 +222,7 @@ The interval to chunk your data range. Each bucket spans a value range of [0..in
222222
Intervals implicitly defines an absolute grid of buckets `[interval * k, interval * (k + 1))`.
223223
Offset makes it possible to shift this grid into `[offset + interval * k, offset + interval (k + 1))`. Offset has to be in the range [0, interval).
224224

225-
As an example, if there are two documents with value 8 and 12 and interval 10.0, they would fall into the buckets with the key 0 and 10. With offset 5 and interval 10, they would both fall into the bucket with they key 5 and the range [5..15)
225+
As an example, if there are two documents with value 8 and 12 and interval 10.0, they would fall into the buckets with the key 0 and 10. With offset 5 and interval 10, they would both fall into the bucket with the key 5 and the range [5..15)
226226

227227
```json
228228
{
@@ -381,7 +381,7 @@ Offset makes it possible to shift this grid into `[offset + interval * k, offset
381381

382382
This is especially useful when using `fixed_interval`, to shift the first bucket e.g. at the start of the year.
383383

384-
The `offset` parameter is has the same syntax as the `fixed_interval` parameter, but also allows for negative values.
384+
The `offset` parameter has the same syntax as the `fixed_interval` parameter, but also allows for negative values.
385385

386386
###### **min_doc_count**
387387

@@ -508,7 +508,7 @@ term-count.
508508

509509
Even with a larger `shard_size` value, doc_count values for a terms aggregation may be
510510
approximate. As a result, any sub-aggregations on the terms aggregation may also be approximate.
511-
`sum_other_doc_count` is the number of documents that didn’t make it into the the top size
511+
`sum_other_doc_count` is the number of documents that didn’t make it into the top size
512512
terms. If this is greater than 0, the terms agg had to throw away some
513513
buckets, either because they didn’t fit into `size` on the root node or they didn’t fit into
514514
`shard_size` on the leaf node.
@@ -907,7 +907,7 @@ The default value is 2.
907907

908908
### Sum
909909

910-
A single-value metric aggregation that that sums up numeric values that are that are extracted from the aggregated documents.
910+
A single-value metric aggregation that sums up numeric values that are that are extracted from the aggregated documents.
911911
Supported field types are `u64`, `f64`, `i64`, and `datetime`.
912912

913913
**Request**

quickwit/quickwit-actors/src/actor_context.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ impl<A: Actor> ActorContext<A> {
225225
/// If the reply is important, chances are the `.ask(...)` method is
226226
/// more indicated.
227227
///
228-
/// Droppping the receiver channel will not cancel the
228+
/// Dropping the receiver channel will not cancel the
229229
/// processing of the message. It is a very common usage.
230230
/// In fact most actors are expected to send message in a
231231
/// fire-and-forget fashion.

quickwit/quickwit-control-plane/src/indexing_scheduler/scheduling/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -474,7 +474,7 @@ fn assign_shards(
474474
let mut shard_to_indexer: HashMap<ShardId, String> =
475475
HashMap::with_capacity(missing_shards.len());
476476

477-
// In a first pass we first assign as many shards on the their hosting nodes as possible.
477+
// In a first pass we first assign as many shards on their hosting nodes as possible.
478478
let mut remaining_missing_shards: Vec<ShardId> = Vec::new();
479479
for shard_id in missing_shards {
480480
// As a heuristic, we pick the first node hosting the shard that is available.

quickwit/quickwit-indexing/src/actors/indexing_pipeline.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -945,7 +945,7 @@ mod tests {
945945
.process_pending_and_observe()
946946
.await;
947947
assert_eq!(obs.generation, 1);
948-
// Let's shutdown the indexer, this will trigger the the indexing pipeline failure and the
948+
// Let's shutdown the indexer, this will trigger the indexing pipeline failure and the
949949
// restart.
950950
let indexer = universe.get::<Indexer>().into_iter().next().unwrap();
951951
let _ = indexer.ask(Command::Quit).await;

quickwit/quickwit-ingest/src/ingest_v2/router.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ impl IngestRouter {
155155
}
156156

157157
/// Inspects the shard table for each subrequest and returns the appropriate
158-
/// [`GetOrCreateOpenShardsRequest`] request if open shards do not exist for all the them.
158+
/// [`GetOrCreateOpenShardsRequest`] request if open shards do not exist for all of them.
159159
async fn make_get_or_create_open_shard_request(
160160
&self,
161161
workbench: &mut IngestWorkbench,

quickwit/quickwit-ingest/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ pub async fn init_ingest_api(
8383
Ok(ingest_api_service)
8484
}
8585

86-
/// Returns the instance of the single IngestApiService via a copy of it's Mailbox.
86+
/// Returns the instance of the single IngestApiService via a copy of its Mailbox.
8787
pub async fn get_ingest_api_service(
8888
queues_dir_path: &Path,
8989
) -> anyhow::Result<Mailbox<IngestApiService>> {

quickwit/quickwit-integration-tests/src/test_utils/cluster_sandbox.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ impl ClusterSandboxBuilder {
165165
}
166166
}
167167

168-
/// Intermediate state where the ports of all the the test cluster nodes have
168+
/// Intermediate state where the ports of all the test cluster nodes have
169169
/// been reserved and the configurations have been generated.
170170
pub struct ResolvedClusterConfig {
171171
temp_dir: TempDir,

0 commit comments

Comments
 (0)