On Mon Mar 26 16:11 2012, Zack Maril wrote:
> Here's one way of going about getting the bare bones for examples:
> 
> Simple examples with autodoc:
> http://clojure-examples.herokuapp.com/clojure.core-api.html#clojure.core/+
> 
> The changes to autodoc required to make this happen:
> https://github.com/zmaril/autodoc/commit/4cb3d7aa1079f0859b129469ea1163e306a1f5ef
> 
> Adding in metadata to the + function:
> https://github.com/zmaril/clojure/commit/2d4902239d8595af74cf17264414a51128de639a
> 
> It sounds like the community has rejected the inclusion of examples in the
> past. But, for reference, it's *really* easy to include examples and make
> them work out of the box. You can just include whatever code you want and
> eval it (no security/speed worries since it is static html you yourself
> are compiling).
> -Zack

On a related not, just because examples won't be added to the core, that
doesn't mean it can't be added externally.  You can always do something
like:

(alter-meta! #'clojure.core/+ assoc :examples […])

This way all of the example code could be kept outside of the core but
still associated with the core functions.

Sincerely,

Daniel

Attachment: signature.asc
Description: Digital signature

Reply via email to