GiovineItalia / Compose.jl

Declarative vector graphics
http://giovineitalia.github.io/Compose.jl/latest/
Other
248 stars 81 forks source link

Improve documentation for introspect #420

Open tbenst opened 3 years ago

tbenst commented 3 years ago

Introspec seems really neat, but the current documentation isn't sufficient to understand the "why" of the tool, or how/when it is useful. Perhaps a few sentences explaining the "decoder ring" would help? Right now, I can understand the syntax, which seems to show how to draw the output of introspect, but that doesn't exactly explain the purpose / utility.

It also introduces a nifty table struct, which doesn't have any documentation--I'll open a new issue for that

Mattriks commented 3 years ago

To me it looks like that introspect was included purely for teaching purposes, rather than as a real development tool.