Skip to content

Commit fc90461

Browse files
Typos
1 parent da89621 commit fc90461

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ In addition, the path to `libclang` needs to be set in the environment variable
8888

8989
For details see the following.
9090
- [Check for `LIBCLANG_PATH`](https://github.com/curtisalexander/readstat-rs/blob/main/crates/readstat-sys/build.rs#L78-L82)
91-
- [Building in Github Actions](https://github.com/curtisalexander/readstat-rs/blob/main/.github/workflows/main.yml#L111-L114)
91+
- [Building in GitHub Actions](https://github.com/curtisalexander/readstat-rs/blob/main/.github/workflows/main.yml#L111-L114)
9292

9393
Build
9494
```sh
@@ -155,7 +155,7 @@ readstat preview /some/dir/to/example.sas7bdat --rows 100
155155
#### `csv`
156156
To write parsed data (as `csv`) to a file, invoke the following (default is to write all parsed data to the specified file).
157157

158-
The default `--format` is `csv`. Thus the parameter is elided from the below examples.
158+
The default `--format` is `csv`. Thus, the parameter is elided from the below examples.
159159

160160
```sh
161161
readstat data /some/dir/to/example.sas7bdat --output /some/dir/to/example.csv
@@ -209,9 +209,9 @@ readstat data /some/dir/to/example.sas7bdat --output /some/dir/to/example.parque
209209
### Parallelism
210210
The `data` subcommand includes a parameter for `--parallel` — if invoked, the _**reading**_ of a `sas7bdat` will occur in parallel. If the total rows to process is greater than `stream-rows` (if unset, the default rows to stream is 10,000), then each chunk of rows is read in parallel. Note that all processors on the user's machine are used with the `--parallel` option. In the future, may consider allowing the user to throttle this number.
211211

212-
Note that although reading is in parallel, _**writing**_ is still sequential. Thus one should only anticipate moderate speed-ups as much of the time is spent writing.
212+
Note that although reading is in parallel, _**writing**_ is still sequential. Thus, one should only anticipate moderate speed-ups as much of the time is spent writing.
213213

214-
:heavy_exclamation_mark: Utilizing the `--parallel` parameter will increase memory usage — there will be multiple threads simultaneously reading chunks from the `sas7bdat`. In addition because all processors are utilized, CPU usage may be maxed out during reading.
214+
:heavy_exclamation_mark: Utilizing the `--parallel` parameter will increase memory usage — there will be multiple threads simultaneously reading chunks from the `sas7bdat`. In addition, because all processors are utilized, CPU usage may be maxed out during reading.
215215

216216
:warning: Also, note that utilizing the `--parallel` parameter may write rows out of order from the original `sas7bdat`.
217217

@@ -369,8 +369,8 @@ Flamegraph is written to `readstat/flamegraph.svg`.
369369

370370
:memo: Have yet to utilize flamegraphs in order to improve performance.
371371

372-
## Github Actions
373-
Below is the rough `git tag` dance to delete and/or add tags to [trigger Github Actions](https://github.com/curtisalexander/readstat-rs/blob/main/.github/workflows/main.yml#L7-L10).
372+
## GitHub Actions
373+
Below is the rough `git tag` dance to delete and/or add tags to [trigger GitHub Actions](https://github.com/curtisalexander/readstat-rs/blob/main/.github/workflows/main.yml#L7-L10).
374374

375375
```sh
376376
# delete local tag

0 commit comments

Comments
 (0)