Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix a handful of typos and check for new ones in CI #124

Merged
merged 2 commits into from
Mar 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading