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

docs: Update the library name to include the Arduino prefix #22

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

dido18
Copy link

@dido18 dido18 commented Feb 10, 2025

Motivation

Following the policy the Arduino official libraries must start with "Arduino"

Changes

  • Rename the name into Arduino_Modulino
  • updated the examples to include the Arduino_Modulino.h header (that includes the old Modulino.h)

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
@dido18 dido18 changed the title docs: update the name of the library with the Arduino prefix docs: Update the library name to include the Arduino prefix Feb 10, 2025
@per1234 per1234 added the bug Something isn't working label Feb 10, 2025
Copy link

@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.

To accompany the name change I suggest the addition of a header file named Arduino_Modulino.h, and changing the examples to use that file in the #include directive instead of Modulino.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 existing Modulino.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
Copy link

CLAassistant commented Feb 11, 2025

CLA assistant check
All committers have signed the CLA.

Copy link

@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.

Copy link

@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.

Thanks Davide!

@leonardocavagnis
Copy link
Contributor

@dido18 I've recently added documentation to the library. Please resolve any conflicts before merging and make sure to integrate the documentation. Thanks! :)

@leonardocavagnis leonardocavagnis self-requested a review March 19, 2025 09:43
dido18 added 2 commits March 19, 2025 11:16
… Arduino_Modulino.h
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants