Skip to content

Descriptive mouseOver messages #134

@lemio

Description

@lemio

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

Metadata

Metadata

Assignees

Labels

topic: codeRelated to content of the project itselftype: enhancementProposed improvement

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions