Hi,
it was discussed before whether examples should go into the docstring.
Or to an :examples metadata to be even executable at the repl. Some
expressed the opinion that docstring should be short and that such
additional documentation should go somewhere else. I don't remember
what the outcome of
Yeah, I've got a permanent clojuredocs tab open all the time, but
still it would be nice to settle this discussion, as currently their
are doc strings that require a google search or a look at the source
to see what they mean though, which is not ideal. Many of us are
happy to help if we can have
Another option is to create a function which pulls examples from
clojuredocs.org on the fly (it has an API) and displays them in the
REPL. I made a proof-of-concept for this but using the now-defunct
Clojure Examples Wiki: https://gist.github.com/470031.
The utility of something like this would
Jark does exactly this:
http://icylisper.in/jark/doc.html
Regards,
Shantanu
On Apr 8, 8:45 pm, Justin Kramer jkkra...@gmail.com wrote:
Another option is to create a function which pulls examples from
clojuredocs.org on the fly (it has an API) and displays them in the
REPL. I made a
I will put in a plug for my much neglected postdoc
https://github.com/markmfredrickson/postdoc
This takes the :examples approach (though it namespaces it within
another map: metadata - :postdoc - {:examples ... :see-also
... }).
Some ways to focus your effort would be to start a project that
