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

Accidentally wrote the wrong name in library.properties #422

Closed
cygig opened this issue Aug 28, 2021 · 3 comments
Closed

Accidentally wrote the wrong name in library.properties #422

cygig opened this issue Aug 28, 2021 · 3 comments
Assignees
Labels
conclusion: resolved Issue was resolved topic: rename Change registered library name

Comments

@cygig
Copy link
Contributor

cygig commented Aug 28, 2021

I misspelled my library as "DailyStrugleButton" instead of "DailyStruggleButton" in library.properties. After the library was live on the library manager, I edited the library.properties and the indexer (http://downloads.arduino.cc/libraries/logs/github.com/cygig/DailyStruggleButton/) doesn't seem too happy with the edited name. What should I do?

@per1234
Copy link
Contributor

per1234 commented Aug 28, 2021

Hi @cygig. As you noticed, the library is locked to the name it had at the time of the admission to the list. The reason is that this is the sole unique identifier for the library, used by other libraries to specify it as a dependency (e.g., depends=DailyStruggleButton, or in CLI commands (e.g., arduino-cli lib install DailyStruggleButton) and so changing it can be disruptive to the users. However, we do allow name changes by request. There is less chance for the name change to have an impact in a case like this when the library has not been in Library Manager very long, and so is not likely to have accumulated references to the old name.

The requested change is now in progress. So there is no further action required from you. This issue serves as the name change request.

Unlike submissions, this type of request is still handled manually. The Library Manager index's maintainer occasionally comes through to clear all the outstanding requests and closes those issues/PRs when that is done. So you can get a notification if you're following this issue or the relevant PR: #423

After that, you can monitor the indexing of the library via its logs web page.

By the way, I very much enjoyed the illustration in your readme!

@cygig
Copy link
Contributor Author

cygig commented Aug 28, 2021

Thank you very much! I am ashamed to say I have little idea of how github works despite being a hobbyist programmer for years. Obviously proofreading and spell checking isn't my strong suit.

@umbynos umbynos removed the rename label Sep 16, 2021
@rsora rsora added the topic: rename Change registered library name label Sep 22, 2021
@rsora
Copy link
Contributor

rsora commented Sep 23, 2021

Solved by #423

@rsora rsora closed this as completed Sep 23, 2021
@per1234 per1234 added the conclusion: resolved Issue was resolved label Nov 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conclusion: resolved Issue was resolved topic: rename Change registered library name
Projects
None yet
Development

No branches or pull requests

5 participants