search

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

Documentation improvements #3

Closed takikawa closed 10 years ago

takikawa commented 10 years ago

This pull request removes a few warnings that occur when building the docs. The identifier hyperlinks should then work better. Also adjust some contracts.

soegaard commented 10 years ago

Thanks!

I appreciate your explanation of the for-label / include-section problem I had.

soegaard commented 10 years ago

About the directory layout. If I have understood the structure of multiple packages correctly, the outer metapict holds (future) collections such as metapict, metapict-doc, metapict-examples etc. Now metapict/metapict holds the collection that (require metapict) should require. After checking the info file, I see that it isn't declared as a 'multi package yet. I'll look into that.

takikawa commented 10 years ago

If you'd like to add additional collections in the package in the future, then yes it would make sense to use 'multi. In that case, you would want to move the main.rkt from the top-level directory. Note that if you were looking at the structure of the math collection for guidance, the sub-directories like "math-doc" and so on are actually separate packages so doesn't necessarily translate well to your use case.