Clojure

Document the availability/usage of *e, *1, *2, ... in REPL

Details

  • Type: Enhancement Enhancement
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Completed
  • Affects Version/s: Release 1.5
  • Fix Version/s: None
  • Component/s: None

Description

For new users of Clojure, it is very hard to find out that evaluation results in any Clojure REPL are bound to *1 - *3 and the latest exception to *e. Since it is a pretty useful feature, it should be documented at a visible place. Where that place is, I am not sure.

One possibility would be to add it to the docstring of clojure.main/repl and make http://clojure.org/repl_and_main link to it (i.e. in the "Launching a REPL" section, we could add something like "Read the <link to=somewhere>docstring of clojure.main/repl</link> to learn about options and available vars. See also utility functions/macros in the clojure.repl namespace."

Note: This was originally reported under nREPL in NREPL-43.

Activity

Hide
Jakub Holy added a comment -

Lovely, thanks!

Show
Jakub Holy added a comment - Lovely, thanks!
Hide
Alex Miller added a comment -

I updated the http://clojure.org/repl_and_main page to include much of this info.

Show
Alex Miller added a comment - I updated the http://clojure.org/repl_and_main page to include much of this info.

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: