Skip to content

Commit

Permalink
fixed typos from documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
a5dur committed Aug 7, 2023
1 parent a1dccc7 commit 3ee671c
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ As such, only the latest release will have security updates.

## Reporting a Vulnerability

If you've found a vulnerability, pleases [create an issue](https://github.com/jqnatividad/qsv/issues/new/choose) in GitHub.
If you've found a vulnerability, please [create an issue](https://github.com/jqnatividad/qsv/issues/new/choose) in GitHub.

However, if a vulnerability is severe and could lead to zero-day
exploits, please send an email to [[email protected]](mailto:[email protected]) instead.
Expand Down
2 changes: 1 addition & 1 deletion docs/Describegpt.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Note that `--json` may not be used alongside `--jsonl`, nor may they both be set

## `--jsonl`

Similar to `--json`, you can use the the `--jsonl` option to expect [JSON Lines](https://jsonlines.org/) output.
Similar to `--json`, you can use the `--jsonl` option to expect [JSON Lines](https://jsonlines.org/) output.

If you use `--output` with `--jsonl`, the output will be written to a new file if it doesn't exist and any lines after the first will be appended to the file. If the file already exists, the output will be appended to the file. Each inference option (`--dictionary`, `--description`, `--tags`) will be written to a new line in the file.

Expand Down
2 changes: 1 addition & 1 deletion docs/ENVIRONMENT_VARIABLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ When processing `.env` files, qsv will:
* where multiple declarations of the same variable exist, the last one will be used
* ignore any lines that start with `#` (comments)

To facilitate the use of `.env` files, a [`dotenv.template.yaml`](../dotenv.template.yaml) file is included in the qsv distribution. This file contains all the environment variables that qsv recognizes, along with their default values. Copy the template a file named '.env' and modify it to suit your needs.
To facilitate the use of `.env` files, a [`dotenv.template.yaml`](../dotenv.template.yaml) file is included in the qsv distribution. This file contains all the environment variables that qsv recognizes, along with their default values. Copy the template to a file named '.env' and modify it to suit your needs.
2 changes: 1 addition & 1 deletion docs/PERFORMANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ There are a number of commands/modes however (denoted by the "exploding head" em
In addition, `frequency`, `schema` and `tojsonl` - though they do not load the entire file into memory, uses additional memory proportional to the cardinality (number of unique values) of each column compared to other "streaming" commands (denoted by the "persevering face" emoji - 😣).

For very large files, this can be a problem, as qsv will run of memory and panic.
For very large files, this can be a problem, as qsv will run out of memory and panic.
To prevent this, qsv has two memory check heuristics when running "non-streaming" commands:

### NORMAL mode
Expand Down
4 changes: 2 additions & 2 deletions docs/whirlwind_tour.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ bg Nadezhda
ru Rabog
```

Whoops! The sample we got don't have population counts. It's quite pervasive.
Whoops! The sample we got doesn't have population counts. It's quite pervasive.
Exactly how many cities have empty (NULL) population counts?

```
Expand Down Expand Up @@ -215,7 +215,7 @@ $ qsv headers country_continent.csv
1 # https://datahub.io/JohnSnowLabs/country-and-continent-codes-list
```

Huh!?! That's not what we we were expecting. But if you look at the `country-continent.csv`
Huh!?! That's not what we were expecting. But if you look at the `country-continent.csv`
file, it starts with a comment with the `#` character.

```
Expand Down

0 comments on commit 3ee671c

Please sign in to comment.