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

LED API docs only offer LedBarGraph sample #382

Open
patridge opened this issue Nov 7, 2022 · 3 comments
Open

LED API docs only offer LedBarGraph sample #382

patridge opened this issue Nov 7, 2022 · 3 comments
Assignees
Labels

Comments

@patridge
Copy link
Collaborator

patridge commented Nov 7, 2022

Pages:

These docs for both LED and PWM LED only offer docs specific to the LedBarGraph class. It would probably be nice to include a much simpler LED and PWM LED example.

Besides not showing the expected example, it can cause further confusion. Coming from the Peripherals page, it shows
links for Led and LedBarGraph. But when going to Led and only seeing an example for LedBarGraph, it makes you think you clicked the wrong link.

@NevynUK
Copy link
Collaborator

NevynUK commented Dec 7, 2023

Links to the sources also take you to the LED bar graph samples in github.

@patridge
Copy link
Collaborator Author

Looks like we have a mixed update. Those linked pages no longer reference LedBarGraph, but there are now new very-minimally different URLs for those two API endpoints that do still reference only LedBarGraph. We now want to address this issue on these two pages. I'll update the initial report accordingly.

@patridge
Copy link
Collaborator Author

@adrianstevens Is it possible that the code snippet system is incorrectly identifying the Meadow.Foundation.Leds.LedBarGraph sample for the plain Meadow.Foundation.Leds page instead of this one?

https://github.com/WildernessLabs/Meadow.Foundation/blob/develop/Source/Meadow.Foundation.Core.Samples/Leds.Led_Sample/MeadowApp.cs

@patridge patridge added the p1 label Jun 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants