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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use accurate description for platform bundled library examples in menu #1304

Open
3 tasks done
per1234 opened this issue Aug 7, 2022 · 0 comments
Open
3 tasks done
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement

Comments

@per1234
Copy link
Contributor

per1234 commented Aug 7, 2022

Describe the request

Change the heading text of the platform bundled libraries section of the File > Examples menu from the current format:

Examples for <board name>

to:

Examples for <platform name>

馃檪 The IDE will no longer make unsubstantiated claims of board-specific compatibility of platform bundled examples to the users accessing them via the File > Examples menu.

Describe the current behavior

The installations of Arduino boards platforms may contain "platform bundled libraries", which are only accessible when a board of that platform is selected in the Arduino IDE.

The Arduino IDE places the example sketches of platform bundled libraries in a dedicated section under the File > Examples menu. The heading text of this section follows the format "Examples for <board name>", where "<board name>" is the name of the currently selected board. This description is not guaranteed to be correct because all examples of all libraries of the platform are listed here, while the libraries or examples may only be compatible with a specific board of the platform.

There is no mechanism for the Arduino IDE to determine whether a sketch or library is compatible with a specific board.

馃檨 The File > Examples menu section makes incorrect claims of board compatibility for some platform bundled library examples.

An arbitrary example of this is the "SAMD_BootloaderUpdater" library bundled with the official "Arduino SAMD (32-bits ARM Cortex-M0+) Boards" platform. This library is written to be used only with the "MKR Vidor 4000" board, and attempting to compile its example sketch for any other board will result in an error. Yet, the "UpdateBootloader" example of this library is described as being "for" the currently selected board even when it is not a MKR Vidor 4000.

image

Arduino IDE version

2.0.0-rc9.1-snapshot-0b33b51

Operating system

All

Operating system version

Any

Additional context

Real world example of the current menu selection heading causing confusion: arduino/ArduinoCore-mbed#529 (comment)

Issue checklist

  • I searched for previous requests in the issue tracker
  • I verified the feature was still missing when using the latest nightly build
  • My request contains all necessary details
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

1 participant