Hi
I’m teaching myself bibliopixel and noticing a lot of the documentation is out of date. So far I’ve been muddling through and diving into the code to work things out, rather than bothering the list.
But I was wondering, is there anything I can do to help getting things updated? I’m guessing that things are lagging while you focus on 3.0
James
James,
Which docs exactly are you looking at? The wiki should be pretty up to date with the current (v3.3.3) release except for maybe a few advanced and experimental features. Granted I agree it needs to be greatly improved but what was lacking for you? I believe you, just want more details on you view of the docs. It’s easily for us to overlook possibly obvious things when we wrote it and just know it well 
I’m actually working right now to add sphinx docs to all the code so that our docs are always up to date and auto generated by Travis CI for us. But I haven’t had a ton of time to finish that up lately. Once that’s all done it will be a lot easier to keep up with.
Certainly won’t turn down help with keeping the docs honest 
one thing we’ll need to do once sphinx is work is move all the docs into code.
Adam
On Nov 3, 2017 4:51 PM, “James Heaver” james@heaver.org wrote:
Hi
I’m teaching myself bibliopixel and noticing a lot of the documentation is out of date. So far I’ve been muddling through and diving into the code to work things out, rather than bothering the list.
But I was wondering, is there anything I can do to help getting things updated? I’m guessing that things are lagging while you focus on 3.0
James
–
You received this message because you are subscribed to the Google Groups “Maniacal Labs Users” group.
To unsubscribe from this group and stop receiving emails from it, send an email to maniacal-labs-users+unsubscribe@googlegroups.com.
To post to this group, send email to maniacal-labs-users@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/maniacal-labs-users/e83ffe4e-847f-4610-a275-2d61ab605320%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
The one I can remember off the top of my head is with animation sequences - the documentation still refers to addAnim rather than add_animation
https://github.com/ManiacalLabs/BiblioPixel/wiki/Animations#addanim
I noticed a couple of others as I was going through things too, but I can’t remember what now.
There are also some bits that would be useful to include in the documentation (imho) such as the project alias list - https://github.com/ManiacalLabs/BiblioPixel/blob/ea3455b58ab741ac1d5319373a87f85dad3346dc/bibliopixel/project/alias_lists.py
I’ve got an event coming up next weekend which I’ve got to get something this project working for (eep!), but after that I should have some more time to get involved with the documentation. I’ve not contributed to anything before, so may need some handholding to begin with. But I’m a quick study and happy to devote some time to this.
As I’m teaching myself bibliopixel from scratch (and have very limited programming experience) I can also be a good “idiot test” for things which might need more explanation.
James
PS - Tom, there is something up the https on tom.ritchford.com
On Saturday, 4 November 2017 10:28:52 UTC, Tom Swirly wrote:
And to second Adam - any help you can give us with documentation would be very much appreciated indeed. Even just telling us the places that need the most help is particularly useful.
On Sat, Nov 4, 2017 at 3:53 AM, Adam Haile adamm...@gmail.com wrote:
James,
Which docs exactly are you looking at? The wiki should be pretty up to date with the current (v3.3.3) release except for maybe a few advanced and experimental features. Granted I agree it needs to be greatly improved but what was lacking for you? I believe you, just want more details on you view of the docs. It’s easily for us to overlook possibly obvious things when we wrote it and just know it well
I’m actually working right now to add sphinx docs to all the code so that our docs are always up to date and auto generated by Travis CI for us. But I haven’t had a ton of time to finish that up lately. Once that’s all done it will be a lot easier to keep up with.
Certainly won’t turn down help with keeping the docs honest
Adam
On Nov 3, 2017 4:51 PM, “James Heaver” ja...@heaver.org wrote:
Hi
I’m teaching myself bibliopixel and noticing a lot of the documentation is out of date. So far I’ve been muddling through and diving into the code to work things out, rather than bothering the list.
But I was wondering, is there anything I can do to help getting things updated? I’m guessing that things are lagging while you focus on 3.0
James
–
You received this message because you are subscribed to the Google Groups “Maniacal Labs Users” group.
To unsubscribe from this group and stop receiving emails from it, send an email to maniacal-labs-users+unsubscribe@googlegroups.com.
To post to this group, send email to maniacal-...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/maniacal-labs-users/e83ffe4e-847f-4610-a275-2d61ab605320%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
–
You received this message because you are subscribed to the Google Groups “Maniacal Labs Users” group.
To unsubscribe from this group and stop receiving emails from it, send an email to maniacal-labs-users+unsubscribe@googlegroups.com.
To post to this group, send email to maniacal-...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/maniacal-labs-users/CAG8g-TYgnOxnQeBxVrEztDm%2BdXAyG%3Dke_nfUNZfJjfPj1aKv8Q%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.
–
/t
James,
Right you are! We renamed a bunch of stuff and it looks like we renamed the actual entry but not the link to it for add_animation.
I’ll take another couple passes through the docs to see if anything else pops out. This is all the more reason I’m moving to generated documentation from code
And I’ll add the alias list In the very near future using the project json files is pretty much going to be the only way to use bibliopixel, but not until 4.0, so we’ll be sure to make all that documentation really awesome.
And we totally get having a big project deadline, so don’t hesitate to reach out if you need any help.
On Sat, Nov 4, 2017 at 9:00 PM, James Heaver james@heaver.org wrote:
The one I can remember off the top of my head is with animation sequences - the documentation still refers to addAnim rather than add_animation
https://github.com/ManiacalLabs/BiblioPixel/wiki/Animations#addanim
I noticed a couple of others as I was going through things too, but I can’t remember what now.
There are also some bits that would be useful to include in the documentation (imho) such as the project alias list - https://github.com/ManiacalLabs/BiblioPixel/blob/ea3455b58ab741ac1d5319373a87f85dad3346dc/bibliopixel/project/alias_lists.py
I’ve got an event coming up next weekend which I’ve got to get something this project working for (eep!), but after that I should have some more time to get involved with the documentation. I’ve not contributed to anything before, so may need some handholding to begin with. But I’m a quick study and happy to devote some time to this.
As I’m teaching myself bibliopixel from scratch (and have very limited programming experience) I can also be a good “idiot test” for things which might need more explanation.
James
PS - Tom, there is something up the https on tom.ritchford.com
On Saturday, 4 November 2017 10:28:52 UTC, Tom Swirly wrote:
And to second Adam - any help you can give us with documentation would be very much appreciated indeed. Even just telling us the places that need the most help is particularly useful.
On Sat, Nov 4, 2017 at 3:53 AM, Adam Haile adamm...@gmail.com wrote:
James,
Which docs exactly are you looking at? The wiki should be pretty up to date with the current (v3.3.3) release except for maybe a few advanced and experimental features. Granted I agree it needs to be greatly improved but what was lacking for you? I believe you, just want more details on you view of the docs. It’s easily for us to overlook possibly obvious things when we wrote it and just know it well
I’m actually working right now to add sphinx docs to all the code so that our docs are always up to date and auto generated by Travis CI for us. But I haven’t had a ton of time to finish that up lately. Once that’s all done it will be a lot easier to keep up with.
Certainly won’t turn down help with keeping the docs honest
Adam
On Nov 3, 2017 4:51 PM, “James Heaver” ja...@heaver.org wrote:
Hi
I’m teaching myself bibliopixel and noticing a lot of the documentation is out of date. So far I’ve been muddling through and diving into the code to work things out, rather than bothering the list.
But I was wondering, is there anything I can do to help getting things updated? I’m guessing that things are lagging while you focus on 3.0
James
–
You received this message because you are subscribed to the Google Groups “Maniacal Labs Users” group.
To unsubscribe from this group and stop receiving emails from it, send an email to maniacal-labs-users+unsubscribe@googlegroups.com.
To post to this group, send email to maniacal-...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/maniacal-labs-users/e83ffe4e-847f-4610-a275-2d61ab605320%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
–
You received this message because you are subscribed to the Google Groups “Maniacal Labs Users” group.
To unsubscribe from this group and stop receiving emails from it, send an email to maniacal-labs-users+unsubscribe@googlegroups.com.
To post to this group, send email to maniacal-...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/maniacal-labs-users/CAG8g-TYgnOxnQeBxVrEztDm%2BdXAyG%3Dke_nfUNZfJjfPj1aKv8Q%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.
–
/t
–
You received this message because you are subscribed to the Google Groups “Maniacal Labs Users” group.
To unsubscribe from this group and stop receiving emails from it, send an email to maniacal-labs-users+unsubscribe@googlegroups.com.
To post to this group, send email to maniacal-labs-users@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/maniacal-labs-users/8c65f860-f724-4773-8de9-aae181a43d61%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.