Correct docs accuracy/stability?

General

ishotjr

6 years ago

How accurate/stable are the docs at present?  For example, I tried to `setColor(MAGENTA)` per:


https://gamebuino.com/academy/reference/graphics-setcolor


but got an error; taking a quick look at the source, it seems magenta doesn't exist - but pink does:


https://github.com/Gamebuino/Gamebuino-META/blob/c49f7fafd7d81a3d86e90608549a19c9867f35b8/src/utility/Graphics/Graphics.cpp#L56


and switching to `setColor(PINK)` worked fine! :)


OT: how do you format code in these forums? :) (also...emojis!??! :D )

jicehel

NEW 6 years ago

They are working on library and docs atm so doc isn't really stable / finished but you make them gain time when you see and give them these errors. It's quicker to correct it.

Aurélien Rodot

NEW 6 years ago

Hi ishotjr, thanks for the report, it's fixed!

As jicehel said, yes we are working on the library and documentation, everything moves fast and sometimes we break things. Don't hesitate to report anything like you did :)

Also code formatting is here, but nobody finds it so I guess I'll change the menu:

ishotjr

NEW 6 years ago

Thanks! Are docs something we can help update directly? :)

Aurélien Rodot

6 years ago

Not really, we didn't go for a wiki this time. But if you want to contribute or report typos, please don't hesitate :)

Aurélien Rodot

NEW 6 years ago

ishotjr ishotjr

Not really, we didn't go for a wiki this time. But if you want to contribute or report typos, please don't hesitate :)