pxt-neopixel documentation is minimal

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!

Oct 22 '19 12:10 whaleygeek

@pelikhan @ganicke could you review the docs here?

Oct 23 '19 08:10 microbit-mark

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

Oct 23 '19 15:10 whaleygeek

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

Oct 23 '19 21:10 ganicke

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

Dec 13 '19 13:12 microbit-mark

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.

Jan 30 '20 08:01 microbit-mark