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

documentation is minimal #47

Open
whaleygeek opened this issue Oct 22, 2019 · 5 comments
Open

documentation is minimal #47

whaleygeek opened this issue Oct 22, 2019 · 5 comments

Comments

@whaleygeek
Copy link

The documentation for this package is not complete - right-clicking on 'help' for any of the NeoPixel package docs takes you to this very basic docs page, and many of the blocks have no help at all.

https://makecode.microbit.org/pkg/microsoft/pxt-neopixel

Screen Shot 2019-10-22 at 13 15 52

Given that this is an approved package, it must have gone through an approval process. Does the approval process check correctness and accuracy of the documentation?

This has surfaced directly into makecode.microbit.org so presumably it has passed the micro:bit Foundation's quality review process??

Could be ask the authors to complete the documentation for this package please?

Thanks!

@microbit-mark
Copy link

microbit-mark commented Oct 23, 2019

@pelikhan @ganicke could you review the docs here?

@whaleygeek
Copy link
Author

I noted the following public methods, all of which have a hint in the blocks, but clicking on 'help' takes to the same page that does not offer detailed help about the methods their behaviours, their parameters, and an example of what it does and why that would be useful.

create
rgb
hsl
HueInterpolationDirection
colours
neopixel mode
showColor
showRainbow
showBarGraph
setPixelColor
setMatrixWidth
setMatrixColor
setPixelWhiteLED
show
clear
length
setBrightness
easeBrightness
range
shift
rotate
setPin
power

@ganicke
Copy link

ganicke commented Oct 23, 2019

Adding reference for the blocks would be for en only as this extension (package) is not currently part of our docs translation path.

@microbit-mark
Copy link

microbit-mark commented Dec 13, 2019

Even if its en only, I think this would be a good start @ganicke

@microbit-mark
Copy link

Also, now you can do block embedding in GH pages, this might be a good candidate to have it's own docs site as an example to others. There is a Jekyll theme for JTD that would work nicely.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants