-
Notifications
You must be signed in to change notification settings - Fork 186
Update documentation for unstable_grab feature #68
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
Conversation
Narsil
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we just keep this modification to adding the example for unstable_grab ?
Your example seems broken too as you are not returning the event if it's not a CapsLock key event. (You can run cargo test --all-features --all-targets && cargo clippy --all-features --all-targets to check your PR)
Also could you revert all the text modifications to their previous versions:
global input device event streamfor instance is incorrect both for Windows and MacOS (someone could always be higher up in the chain than you for instance). (And it's not the README's place to dive into OS specific considerations).- Also
OS specificitiesneed to be higher than theunstable_feature, because well unstable is unstable so it's by definition less important than the rest. - also the
listenon linux does not useevdevbut real X11 mechanism (so no special permissions needed).
Caveatsis probably better thanSpecificities` though.
|
Thanks @Narsil, Following your suggestion, I cleaned up the documentation and split the "OS Caveats" section into a separate section for each of the I've run the cargo tests and clippy checks you suggested on windows and MacOS, and all the tests pass. Could you please review? |
Narsil
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, LGTM.
|
In order to pass quality, you should change the |
|
you mean do them as two separate commits? also, on windows 10, If i get a chance, i'll open up another PR with some basic contributor guidelines, based on what I've learned so far :) |
|
not sure how I managed to lose that semicolon, but it's been re-added, and |
|
oh that's an interesting error... i see in the github ctions workflow file that only the serialize feature is enabled, and there's a note saying that I just booted up my linux laptop, cloned the repo to it, and ran the doctests with all features enabled, and it passed all tests. should i add a |
|
Protect the example with |
Update documentation as per #42 (comment)