Compose.jl icon indicating copy to clipboard operation
Compose.jl copied to clipboard

Improve documentation for introspect

Open tbenst opened this issue 3 years ago • 1 comments

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

tbenst avatar May 13 '21 16:05 tbenst

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

Mattriks avatar May 14 '21 23:05 Mattriks