From d4977a6bba438d82a4afd406e343dd8889e2a35b Mon Sep 17 00:00:00 2001 From: Anthony Grimes Date: Tue, 7 Feb 2012 03:06:48 -0600 Subject: [PATCH] Add a docstring to the repl task. --- src/leiningen/repl.clj | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/leiningen/repl.clj b/src/leiningen/repl.clj index dd207476a..75446147c 100644 --- a/src/leiningen/repl.clj +++ b/src/leiningen/repl.clj @@ -18,6 +18,14 @@ (def lein-repl-server (delay (nrepl/start-server))) (defn ^:no-project-needed repl + "Start a repl session either with the current project or standalone. + +This will launch an nREPL server behind the scenes that reply will connect to. +If a :repl-port key is present in project.clj, that port will be used for the +server, otherwise it is chosen randomly. If you run this command inside of a +project, it will be ran in the context of that classpath. If the command is +ran outside of a project, it'll be standalone and the classpath will be +that of Leiningen's." ([] (repl nil)) ([project] (nrepl/reset-ack-port!)