Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pt and vec are documented twice #19

Open
dented42 opened this issue Mar 31, 2015 · 1 comment
Open

pt and vec are documented twice #19

dented42 opened this issue Mar 31, 2015 · 1 comment

Comments

@dented42
Copy link

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
Copy link
Owner

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants