Skip to content
This repository has been archived by the owner on Jul 16, 2024. It is now read-only.

Please document user functions #12

Open
halgari opened this issue Dec 12, 2018 · 1 comment
Open

Please document user functions #12

halgari opened this issue Dec 12, 2018 · 1 comment

Comments

@halgari
Copy link

halgari commented Dec 12, 2018

I'm trying to debug tap> with REBL, as REBL isn't showing any of my tap> data. However, this is a bit difficult as none of the user endpoints seem to have docstrings:

(doc rebl/ui)
-------------------------
cognitect.rebl/ui
([& {:keys [proc], :or {proc server/prepl}}])
@richhickey
Copy link
Contributor

tap is not currently wired up to the UI. We didn't get a chance to remove it before Conj and hope instead now to get it flowing soon.

As far as docs, we are currently only supporting rebl/ui, and the docs you've got indicate ui takes kw-args, and currently only one, :proc, and that the default for :proc is server/prepl - thus prepl is the contract and docs for that apply. We've got new clojure.org docs coming with 1.10 that explain prepl, including a diagram!

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

No branches or pull requests

3 participants