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

Created KeyboardandMousecontrol.ino #32

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

Arsh0508
Copy link

This code would be really helpful for new users and so it'll be great if this code is present in the library itself

@Arsh0508 Arsh0508 changed the title Create KeyboardandMousecontrol.ino Created KeyboardandMousecontrol.ino Mar 15, 2020
Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please spell the sketch name the same as in the existing example sketch: KeyboardAndMouseControl

@per1234
Copy link
Contributor

per1234 commented Mar 16, 2020

As I brought up in arduino-libraries/Mouse#13 (comment):

One thing to note is that this example already comes bundled with the Arduino IDE (and Arduino Web Editor) under File > Examples > 09.USB > KeyboardAndMouseControl.

It does make sense to bundle the examples with the library since the IDE bundled examples are not available to arduino-cli and Arduino Pro IDE users. I don't like the idea of having duplicate code to maintain, but it also could be problematic to remove the built-in sketches since there are likely tutorials that point people to that menu path. I suppose we could replace the content of the built in sketches with a comment like:

// This example has been moved to File > Examples > Keyboard > KeyboardLogout

(should be adapted to make sense for Arduino Web Editor users also)

Copy link
Contributor

@per1234 per1234 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Arsh0508
Copy link
Author

Arsh0508 commented Mar 17, 2020

@per1234 thank you so much for your valuable suggestions sir, will get right onto it and make the needful changes.

@Arsh0508
Copy link
Author

@per1234 I've done the requested changes and would be grateful if you can review them.

Comment on lines +1 to +8
/*
This example has been moved to File > Examples > USB > KeyboardAndMouseControl
https://github.com/arduino/Arduino/tree/master/build/shared/examples/09.USB/KeyboardAndMouseControl
*/

/*
KeyboardAndMouseControl

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/*
This example has been moved to File > Examples > USB > KeyboardAndMouseControl
https://github.com/arduino/Arduino/tree/master/build/shared/examples/09.USB/KeyboardAndMouseControl
*/
/*
KeyboardAndMouseControl

This makes no sense. The example has not been moved to File > Examples > USB > KeyboardAndMouseControl. The example has always been there. The whole point of your pull request is to move (or copy) that sketch FROM File > Examples > USB > KeyboardAndMouseControl TO File > Examples > Mouse > KeyboardAndMouseControl.

There is no benefit to providing a link to the copy of the sketch in the arduino/Arduino repository. If they saw that comment, the user is already looking at the sketch.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@per1234 per1234 added topic: documentation Related to documentation for the project type: enhancement Proposed improvement labels Mar 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants