Skip to content

Commit

Permalink
chore: Fix a handful of typos and check for new ones in CI (#124)
Browse files Browse the repository at this point in the history
* Fix a handful of typos

Most found by https://github.com/crate-ci/typos.

* Check for typos in CI
  • Loading branch information
svix-jplatte authored Mar 18, 2024
1 parent 353313a commit 7e2d71e
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 4 deletions.
16 changes: 16 additions & 0 deletions .github/workflows/typos.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: Typos

on:
push:
branches: [main]
pull_request:
branches: [main]

jobs:
typos:
name: Check for typos
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- uses: crate-ci/[email protected]
9 changes: 9 additions & 0 deletions .typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[default]
extend-ignore-re = [
"ff32ba0",
]

[files]
extend-exclude = [
"crates/aide/res/**/*.js",
]
2 changes: 1 addition & 1 deletion crates/aide/src/axum/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -713,7 +713,7 @@ mod private {
pub trait Sealed {}
}

/// A trait that extens [`axum::handler::Handler`] with API operation
/// A trait that extends [`axum::handler::Handler`] with API operation
/// details.
///
/// Just like axum's `Handler`, it is automatically implemented
Expand Down
2 changes: 1 addition & 1 deletion crates/aide/src/gen.rs
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ pub fn infer_responses(infer: bool) {
});
}

/// Output all theoretically possbile error responses
/// Output all theoretically possible error responses
/// including framework-specific ones.
///
/// This is disabled by default.
Expand Down
2 changes: 1 addition & 1 deletion crates/aide/src/helpers/with_api.rs
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ use crate::{OperationInput, OperationOutput};
/// }
/// ```
pub trait ApiOverride {
/// The type that is being overriden
/// The type that is being overridden
type Target;
}

Expand Down
2 changes: 1 addition & 1 deletion crates/axum-jsonschema/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ impl From<JsonSchemaRejection> for JsonSchemaErrorResponse {
error: "deserialization failed".to_string(),
extra: AdditionalError::Deserialization(DeserializationResponse {
deserialization_error: VecDeque::from([PathError {
// keys and index seperated by a '/'
// keys and index separated by a '/'
// enum is ignored because it doesn't exist in json
instance_location: std::iter::once(String::new())
.chain(s.path().iter().map(|s| match s {
Expand Down

0 comments on commit 7e2d71e

Please sign in to comment.