- Notifications
You must be signed in to change notification settings - Fork20
docs: Update the library name to include the Arduino prefix#22
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Following the [policy](https://forum.arduino.cc/t/new-official-policy-for-the-use-of-arduino-in-library-names/580564) the Arduino official libraries must start with Arduino.Changed the name into `Arduino Modulino` to respect the policy
Arduino
prefixUh oh!
There was an error while loading.Please reload this page.
per1234 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.
To accompany the name change I suggest the addition of a header file namedArduino_Modulino.h
, and changing the examples to use that file in the#include
directive instead ofModulino.h
.
The reason is that the match between the library name and the header file name is a factor in library discovery:
https://arduino.github.io/arduino-cli/dev/sketch-build-process/#library-name-priority
So it is best practices that, in a case like this where a library has a primary header file, that filename match the library name. This will reduce the chance of ambiguity in the library discovery.
This can be done in a non-breaking manner by leaving the existingModulino.h
file in place. One of the two header files should simply contain an#include
directive for the other file. For example:
Arduino_Modulino.h
:
#include"Modulino.h"
CLAassistant commentedFeb 11, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
per1234 left a comment• edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
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.
per1234 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 Davide!
@dido18 I've recently added documentation to the library. Please resolve any conflicts before merging and make sure to integrate the documentation. Thanks! :) |
… Arduino_Modulino.h
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!
c4ec920
intoarduino-libraries:mainUh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Motivation
Following thepolicy the Arduino official libraries must start with "Arduino"
Changes
name
intoArduino_Modulino
Arduino_Modulino.h
header (that includes the oldModulino.h
)