Add spellcheck to CI #3557
Closed
Add spellcheck to CI #3557
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: John Nunley <[email protected]>
winit is a large codebase and manually checking for typos is infeasible. This commit adds a spellcheck hook using cspell to the CI. That way we can be sure that there are no typos in our code before we commit. Signed-off-by: John Nunley <[email protected]>
kchibisov
reviewed
Mar 2, 2024
src/platform/web.rs
Outdated
| @@ -82,7 +82,7 @@ pub trait WindowExtWebSys { | |||
| /// would prevent that. | |||
| /// | |||
| /// Some events are impossible to prevent. E.g. Firefox allows to access the native browser | |||
| /// context menu with Shift+Rightclick. | |||
| /// context menu with Shift+Right-click. | |||
There was a problem hiding this comment.
Generally for combination words (like Rightclick) I try to split it into two words unless it isn't possible (it's part of public API).
Signed-off-by: John Nunley <[email protected]>
Signed-off-by: John Nunley <[email protected]>
notgull
added a commit
to rust-windowing/raw-window-handle
that referenced
this pull request
Mar 3, 2024
In order to ensure that typos are not introduced in future commits, this commit adds a spellchecker to CI. See also: rust-windowing/winit#3557 Signed-off-by: John Nunley <[email protected]>
notgull
added a commit
to rust-windowing/softbuffer
that referenced
this pull request
Mar 3, 2024
This commit adds a spellchecker to the CI pipeline. This prevents typos from being made in future commits. See also: rust-windowing/winit#3557 Signed-off-by: John Nunley <[email protected]>
daxpedda
approved these changes
Mar 4, 2024
There was a problem hiding this comment.
I've used cargo-spellcheck and typos before, but this one looks good as well.
This is great!
kchibisov
requested changes
Mar 4, 2024
| @@ -150,7 +151,7 @@ pub(crate) fn create_key_event( | |||
|
|
|||
| let logical_key = match text_with_all_modifiers.as_ref() { | |||
| // Only checking for ctrl and cmd here, not checking for alt because we DO want to | |||
| // include its effect in the key. For example if -on the Germay layout- one | |||
| // include its effect in the key. For example if -on the Germany layout- one | |||
There was a problem hiding this comment.
Suggested change
| // include its effect in the key. For example if -on the Germany layout- one | |
| // include its effect in the key. For example if -on the German layout- one |
| @@ -17,7 +17,7 @@ use windows_sys::{ | |||
| pub struct IUnknownVtbl { | |||
| pub QueryInterface: unsafe extern "system" fn( | |||
| This: *mut IUnknown, | |||
| riid: *const GUID, | |||
| r_iid: *const GUID, | |||
There was a problem hiding this comment.
I have a feeling that these are all named after the corresponding arguments in Win32?
|
Closing in favor of #3565 |
notgull
added a commit
to rust-windowing/softbuffer
that referenced
this pull request
Mar 12, 2024
This commit adds a spellchecker to the CI pipeline. This prevents typos from being made in future commits. See also: rust-windowing/winit#3557 Signed-off-by: John Nunley <[email protected]>
notgull
added a commit
to rust-windowing/raw-window-handle
that referenced
this pull request
Mar 13, 2024
In order to ensure that typos are not introduced in future commits, this commit adds a spellchecker to CI. See also: rust-windowing/winit#3557 Signed-off-by: John Nunley <[email protected]>
notgull
added a commit
to rust-windowing/softbuffer
that referenced
this pull request
Mar 13, 2024
This commit adds a spellchecker to the CI pipeline. This prevents typos from being made in future commits. See also: rust-windowing/winit#3557 Signed-off-by: John Nunley <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
winit is a large codebase and manually checking for typos is infeasible.
This commit adds a spellcheck hook using cspell to the CI. That way we
can be sure that there are no typos in our code before we commit.
WIP until I fix all of the typos.
CHANGELOG.mdif knowledge of this change could be valuable to users