Skip to content

Commit

Permalink
docs: grammar and typos
Browse files Browse the repository at this point in the history
  • Loading branch information
mmalenic committed Nov 29, 2024
1 parent 383f825 commit 7b7c4d8
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Thank you for your interest in contributing. We greatly value feedback and contributions, whether that's
an issue, bug fix, new feature or document change. All contributions are welcome, and no change is too small, even if
its just a typo fix.
it's just a typo fix.

To get familiar with the project, have a look at the READMEs of each crate.

Expand All @@ -23,7 +23,7 @@ guidance.

### Tests and formatting

If the proposed change alters the code, tests should updated to ensure that no regressions are made. Any new features
If the proposed change alters the code, tests should update to ensure that no regressions are made. Any new features
need to have thorough testing before they are merged.

We also use [clippy] and [rustfmt] for code style, linting and formatting.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ A **server** implementation of the [htsget protocol][htsget-protocol] for bioinf
[actix-web]: https://github.com/actix/actix-web
[criterion-rs]: https://github.com/bheisler/criterion.rs

## Quick start
## Quickstart

To run a local instance htsget-rs, run [htsget-axum]:

Expand Down
4 changes: 2 additions & 2 deletions htsget-actix/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
[actions-url]: https://github.com/umccr/htsget-rs/actions?query=workflow%3Atests+branch%3Amain

> [!IMPORTANT]
> The functionality of [htsget-axum] is identical to this crate and it is recommended for all
> The functionality of [htsget-axum] is identical to this crate, and it is recommended for all
> projects to use [htsget-axum] instead.
>
> This crate will be maintained to preserve backwards compatibility, however [htsget-axum] is
Expand All @@ -29,7 +29,7 @@ This crate is used for running a local instance of htsget-rs. It is based on:

[htsget-http]: ../htsget-http

## Quick start
## Quickstart

Launch a server instance:

Expand Down
2 changes: 1 addition & 1 deletion htsget-axum/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This crate is used for running a server instance of htsget-rs. It is based on:

[htsget-http]: ../htsget-http

## Quick start
## Quickstart

Launch a server instance:

Expand Down
6 changes: 3 additions & 3 deletions htsget-config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Any config options set by environment variables override values in the config fi

The configuration consists of TOML tables, such as config for the ticket server, data server, service-info, or resolvers.

As a starting point, see the [basic TOML][basic] example file which should work for many use cases.
As a starting point, see the [basic TOML][basic] example file which should work for many use-cases.

#### Ticket server config

Expand Down Expand Up @@ -151,7 +151,7 @@ To create a resolver, add a `[[resolvers]]` array of tables, and set the followi
| `substitution_string` | The replacement expression used to map the matched query ID. This has access to the match groups in the `regex` option. | String with access to capture groups | `'$0'` |

For example, below is a `regex` option which matches a `/` between two groups, and inserts an additional `data`
inbetween the groups with the `substitution_string`.
in between the groups with the `substitution_string`.

```toml
[[resolvers]]
Expand Down Expand Up @@ -498,7 +498,7 @@ There is experimental support for serving [Crypt4GH][c4gh] encrypted files. This
`experimental` feature flag.

This allows htsget-rs to read Crypt4GH files and serve them encrypted, directly to the client. In the process of
serving the data, htsget-rs will decrypt the headers of the Crypt4GH files and reencrypt them so that the client can read
serving the data, htsget-rs will decrypt the headers of the Crypt4GH files and re-encrypt them so that the client can read
them. When the client receives byte ranges from htsget-rs and concatenates them, the output bytes will be Crypt4GH encrypted,
and will need to be decrypted before they can be read. All file formats (BAM, CRAM, VCF, and BCF) are supported using Crypt4GH.

Expand Down
2 changes: 1 addition & 1 deletion htsget-search/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Since this crate is used to query file data, it is the most performance critical
cargo bench -p htsget-search --all-features
```

Alternatively if you are using `cargo-criterion` and want a machine readable JSON output, run:
Alternatively if you are using `cargo-criterion` and want a machine-readable JSON output, run:

```sh
cargo criterion --bench search-benchmarks --message-format=json -- LIGHT 1> search-benchmarks.json
Expand Down

0 comments on commit 7b7c4d8

Please sign in to comment.