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.

Sign up for GitHub

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

Jump to bottom

[Enhancement] More info on apply_autocorrect #21056

Merged
merged 5 commits into from
Jul 7, 2023
Merged

[Enhancement] More info on apply_autocorrect #21056

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6dbde56
Initial code
elpekenin May 26, 2023
7d49c19
Fix typo
elpekenin May 26, 2023
6f6e756
Add clarification
elpekenin May 30, 2023
2d9f1f2
Merge branch 'develop' into feature/autocorrect_strings
drashna Jun 1, 2023
8778f8e
Merge branch 'develop' into feature/autocorrect_strings
drashna Jun 5, 2023
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
Prev Previous commit
Next Next commit
Add clarification
  • Loading branch information
@elpekenin
elpekenin committed May 30, 2023
commit 6f6e756ca4469b6b880d64e243615980b167ca8e
2 changes: 2 additions & 0 deletions docs/feature_autocorrect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,8 @@ bool process_autocorrect_user(uint16_t *keycode, keyrecord_t *record, uint8_t *t

Additionally, `apply_autocorrect(uint8_t backspaces, const char *str, char *typo, char *correct)` allows for users to add additional handling to the autocorrection, or replace the functionality entirely. This passes on the number of backspaces needed to replace the words, as well as the replacement string (partial word, not the full word), and the typo and corrected strings (complete words).

?> Due to the way code works (no notion of words, just a stream of letters), the `typo` and `correct` strings are a best bet and could be "wrong". For example you may get `wordtpyo` & `wordtypo` instead of the expected `tpyo` & `typo`.

#### Apply Autocorrect Example

This following example will play a sound when a typo is autocorrected and execute the autocorrection itself:
Expand Down