On Tue, Oct 26, 2010 at 3:50 AM, Tom Faulhaber <tomfaulha...@gmail.com> wrote:
> It's on the roadmap.
>
> I haven't really figured out a way to do it that fits in with other
> uses of doc strings.
>
> I do know that I want the images to be able to be embedded in the doc
> string so that programs like incanter can use the image as part of the
> narrative, but I want the "markup" that does it to feel natural to
> readers who aren't seeing the image.

I'm not sure what sort of markup you've already thought of, but using
something similar to markdown which has the ability to embed resources
within, but specify them later seems to make sense for this purpose:

(defn foo
   "this function computes foo, given bar, and returns a handle to a
java.awt.image.BufferedImage, which shows a 3D graph (![example
graph][1]) of the function.

[1]: http://foo.bar/examples/foo-bar.png";
  [bar]
  ...)





-- 
http://www.apgwoz.com

-- 
You received this message because you are subscribed to the Google
Groups "Clojure" group.
To post to this group, send email to clojure@googlegroups.com
Note that posts from new members are moderated - please be patient with your 
first post.
To unsubscribe from this group, send email to
clojure+unsubscr...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en

Reply via email to