[skip changelog] Document filter setting capability of Library/Boards Manager links #1958
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
per1234
added
type: enhancement
kittaakos
approved these changes
Oct 31, 2022
There was a problem hiding this comment.
Maybe the docs could mention that unlike the search term in the hash, type and topic must be URL encoded:
Signal Input/Output=> http://librarymanager/All/Signal%20Input%2FOutput#debouncerDevice Control=> http://librarymanager/All/Device%20Control#ServoArduino@Heart=> http://boardsmanager/Arduino%40Heart#littleBits
… Manager links Arduino IDE allows opening searches in Library Manager and Boards Manager by clicking a link with a special format in a comment of the sketch. During the initial implementation in Arduino IDE 1.x, support for setting the "Type" filter via the URI in addition to specifying search keywords was attempted and claimed to work, but never did work. For this reason, it was not previously mentioned in the sketch specification. During the reimplementation of the Library/Boards Manager link feature for Arduino IDE 2.x, the "Type" filter setting capability was finally truly implemented, and expanded to also support setting the "Topic" filter in Library Manager via the same mechanism. Now that support for the filter setting capability has been released in Arduino IDE 2.0.1, it should be documented in the sketch specification.
|
Thanks for your suggestion @kittaakos. I have now implemented it: |
|
Thank you for the update. It looks great. Please proceed with the merge. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
See how to contribute
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)What kind of change does this PR introduce?
Documentation update.
What is the current behavior?
Arduino IDE allows opening searches in Library Manager and Boards Manager by clicking a link with a special format in a comment of the sketch.
During the initial implementation in Arduino IDE 1.x (arduino/Arduino@b99ab40), support for setting the "Type" filter via the URI in addition to specifying search keywords was attempted and claimed to work, but never did work. For this reason, that "feature" was not previously mentioned in the sketch specification.
During the re-implementation of the Library/Boards Manager link feature for Arduino IDE 2.x (arduino/arduino-ide#1481), the "Type" filter setting capability was finally truly implemented, and expanded to also support setting the "Topic" filter in Library Manager via the same mechanism.
This significant new functionality of the Arduino sketch format is undocumented.
What is the new behavior?
The capability released in Arduino IDE 2.0.1 is documented in the sketch specification.
Does this PR introduce a breaking change, and is titled accordingly?
No breaking change.