[Enhancement] More info on apply_autocorrect

[elpekenin]

Description

The information received on the hook was not very useful because it only showed part of global state, namely how to fix it. However it provided no information on what the typo being solved was.

Thus we now also provide both the wrong and corrected versions of the strings.

Also updated its only usage over the repo.

Types of Changes

• Core
• Bugfix
• New feature
• Enhancement/optimization
• Keyboard (addition or update)
• Keymap/layout/userspace (addition or update)
• Documentation

Issues Fixed or Closed by This PR

Checklist

• My code follows the code style of this project: C, Python
• I have read the PR Checklist document and have made the appropriate changes.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• I have tested the changes and verified that they work and don't break anything (as well as I can manage).

[drashna]

found a bug. It looks like it will grab text from before the word to correct:

Autocorrected layeqpayed to layeqpaid
Autocorrected payed to paid
Autocorrected laypaiedpayed to laypaiedpaid

Mostly was trying to trigger "payed", but if you don't have a space before the word, it will include everything up til the last space/terminator character.

[elpekenin]

Not a bug, but a limitation on how the algorithm works

It has no concept of "words" , we just have a stream of chars in which we find for patterns to be replaced (since we can use spaces to hopefully correctly delimit words, my code does so)

I dont think there's a way of fixing this issue without major changes to the correction code

PS: Anyway it doesnt feel like a very common scenario to run into

[drashna]

Yeah. And this issue isn't a stopping issue. However, I think that because this change makes this more obvious, a note about this behavior should be added as it will likely come up more often if/when people can render the "word".