Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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

Merged
sebromero merged 13 commits intoarduino-libraries:mainfromdido18:patch-1
Aug 20, 2025

Conversation

dido18
Copy link
Contributor

@dido18dido18 commentedFeb 10, 2025
edited
Loading

Motivation

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

Changes

  • Rename thename intoArduino_Modulino
  • updated the examples to include theArduino_Modulino.h header (that includes the oldModulino.h)

per1234 reacted with heart emoji
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
@dido18dido18 changed the titledocs: update the name of the library with theArduino prefixdocs: Update the library name to include the Arduino prefixFeb 10, 2025
@per1234per1234 added the bugSomething isn't working labelFeb 10, 2025
Copy link

@per1234per1234 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 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
Copy link

CLAassistant commentedFeb 11, 2025
edited
Loading

CLA assistant check
All committers have signed the CLA.

Copy link

@per1234per1234 left a comment
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

dido18 reacted with thumbs up emoji
Copy link

@per1234per1234 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!

dido18 reacted with heart emoji
@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! :)

dido18 reacted with thumbs up emoji

@leonardocavagnisleonardocavagnis self-requested a reviewMarch 19, 2025 09:43
Copy link
Contributor

@leonardocavagnisleonardocavagnis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Thanks!

@leonardocavagnisleonardocavagnis added the documentationImprovements or additions to documentation labelMay 8, 2025
@sebromerosebromero merged commitc4ec920 intoarduino-libraries:mainAug 20, 2025
2 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@per1234per1234per1234 approved these changes

@leonardocavagnisleonardocavagnisleonardocavagnis approved these changes

Assignees
No one assigned
Labels
bugSomething isn't workingdocumentationImprovements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

5 participants
@dido18@CLAassistant@leonardocavagnis@per1234@sebromero

[8]ページ先頭

©2009-2025 Movatter.jp