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

Descriptive mouseOver messages #134

Open
lemio opened this issue Oct 21, 2019 · 3 comments
Open

Descriptive mouseOver messages #134

lemio opened this issue Oct 21, 2019 · 3 comments
Assignees
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement

Comments

@lemio
Copy link

lemio commented Oct 21, 2019

Is your feature request related to a problem? Please describe.
Since the Arduino ecosystem is made to get people with a limited background of programming or electronics into this field, it would be interesting to consider giving a very short description and link to the reference when hovering over the elements.

Right now it shows the bare minimum on information (not the name of the arguments, datatypes in cpp instead of the more readable Arduino way)
image

Describe the solution you'd like

This is a small attempt to make a description that might be understandable by a beginner, that could be included in the header files, with a hyperlink to the reference and a nicer way to describe the function. *int should be boolean

image

Describe alternatives you've considered
It might be that this function is only enabled in the limited version of the interface; the non-advanced version; but if we could make it a standard to have a short description in the header files; it might actually make life easier for the reader of the header files and the beginning user trying to make sense of a piece of code.

Additional context
This screenshot above is just an example of the concept; the text; color coding; could probably be improved.

These look more like the function itself since it is called digitalWrite:

Write a value to a pin

Write a digital value to a pin

These don't look like the function itself, which could be confusing or enlighting (having different words to describe the same) and the order of the words matches the function's arguments:

Give a pin a digital value

Give a physical pin a digital value

@rsora rsora transferred this issue from arduino/arduino-pro-ide Mar 1, 2021
@silvanocerza silvanocerza added the type: enhancement Proposed improvement label Mar 1, 2021
@per1234
Copy link
Contributor

per1234 commented Nov 1, 2021

link to the reference

There is a similar functionality in the classic Arduino IDE. The way it works is when a reference page name is defined in a keywords.txt file:
https://arduino.github.io/arduino-cli/latest/library-specification/#reference_link
then when you do a Right Click > Find in Reference or Help > Find in Reference while the cursor is on that keyword the reference page is opened in the browser.

@per1234 per1234 added the topic: code Related to content of the project itself label Nov 1, 2021
@rusty-bit

This comment has been minimized.

@per1234

This comment has been minimized.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement
Projects
None yet
Development

No branches or pull requests

5 participants