Library links to wrong page

In the library manager, IDE 2.2.1.

image

Clicking more info takes one to https://playground.arduino.cc although the link indicates playground.arduino.cc/code/keypad as the destination.

Hi @dougp. The target of the "More info" link is defined by the library author in the metadata file:

As for it loading the Arduino Playground home page, you will get the same result even if you open the URL from the metadata file directly in your browser so this is not a fault of Arduino IDE but instead of the Arduino website. Unfortunately some years ago Arduino made the decision to make the Playground read-only and it has been neglected and suffering bit rot since that time.

I see that the URL will lead to the intended page if you add a trailing /:

https://playground.arduino.cc/Code/Keypad/

You can submit a pull request to the library to update the URL in the metadata file, but unfortunately the owner of the library has not made any effort to maintain their Arduino projects for quite a few years so I wouldn't get your hopes up too much for your pull request to be merged if you do that. Even so, the pull request would still serve to document the defect in the library and to make it easier for affected users to find the target Playground page.

Thanks for the info. How is the below accomplished/

There is a guide to contributing to projects on GitHub through pull requests here:

https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests

Please let me know if you have any questions after reading that and giving it a try.

Considering I know little about GitHub's workings, would opening an issue be more suitable than a pull request?

An issue is most appropriate when you have found a defect or want to propose an enhancement, but aren't able to make the necessary changes yourself and are hoping someone else will do that work. The exception would be a case where you are able to make the necessary changes, but they are relatively extensive and subjective and you want to get feedback from other interested parties about the approach before starting on that work.

It doesn't really make sense to submit an issue that will be resolved by a simple straightforward change (in this case the addition of a single character) you already know. There is room for ambiguity when attempting to describe such a change in prose in an issue. Conversely, there is no ambiguity in the change you are proposing when you make a pull request because it is shown in the file diff (though there is certainly the change of ambiguity in the reason for making that change, and this is why it is also important to provide a clear explanation for the change in the commit message/pull request message.

That said, if for some reason you feel that the choice is between contributing to an open source software project via a high quality issue and not contributing at all, then by all means go ahead and submit an issue.

My personal opinion is that it is well worthwhile for any reasonably experienced Arduino user (even if they are purely a hobbyist) to take the time to learn the basics of how to make pull requests, but others might feel differently.

Besides making it read only they also moved the playground pages around so the old links break.

http://playground.arduino.cc/Code/Keypad redirects to

https://playground.arduino.cc/Code/Keypad redirects to

https://playground.arduino.cc/

....Instead of redirecting to:

(which still has the broken link back to playground.)

That is not the intended target of the link. The intended target is this Playground page:

https://playground.arduino.cc/Code/Keypad/

The pages under https://www.arduino.cc/reference/en/libraries/ are automatically generated from the library metadata. So the dysfunctional link on that reference page has the same origin as the one in the Arduino IDE Library Manager, and would be solved by the same procedure (update the value of the url field of the library.properties file in the repository and then make a new release of the library).

1 Like

I did read at the link you gave. I got to

image

and clicked on that - it was bright green before clicking. The only two options I saw were:

image

and I wasn't allowed to start anything at either. I opted for opening an issue instead.

For me, doing anything active at github is pretty much confined to clicking links to files. The rest of it just doesn't make any sense.

I see the issue here:

It is true that the dysfunctional URL is also present in the metadata of the library in that repository, so the issue is valid. However, even if the URL was updated in the file of that repository and a release made, it wouldn't do anything to fix the problem you are reporting here:

The reason is because the repository where you submitted that issue GitHub - Nullkraft/Keypad: Matrix Keypad library for Arduino is not the registered repository for the "Keypad" library in Library Manager so changes in the Nullkraft/Keypad repository won't have any effect on Library Manager.

The repository registered in Library Manager for the "Keypad" library is the one I linked to in post #2:

It is in that repository where the metadata would need to be updated and the new release made in order to resolve the problem with the "More info" link in Library Manager.

Thanks. I've opened an issue at the given page:

Hey, got your github message, I will check it out this weekend and see what can be done.

2 Likes