soegaard / metapict

A graphics library for producing Racket picts in a MetaPost/TikZ style.
http://soegaard.github.io/metapict/
65 stars 13 forks source link

pt and vec are documented twice #19

Open dented42 opened 9 years ago

dented42 commented 9 years ago

currently pt and vec are documented twice, once in representation.scrbl and once in pt.scrbl. I'd suggest that either all data types are documented in one place (representations.scrbl) or each with the code that manipulates them (pt.scrbl). I'd maybe lean towards the latter, as it's nice to have them along with the code that uses them, but seeing them all in one place is nice too...

Either way, I suspect that having them in one place could confuse scribble as to which is the canonical version. Or at least make the version of pt that is linked to when clicking on it nondeterministic.

soegaard commented 9 years ago

Thanks for mentioning this.

I was attempting to write both a Guide and a Reference to MetaPict, but the Guide is far from finished. I'll see if I can get pt to link to the section in the Reference.