Clojure

doc string for resolve mentions &env

Details

  • Type: Enhancement Enhancement
  • Status: Closed Closed
  • Priority: Trivial Trivial
  • Resolution: Declined
  • Affects Version/s: Release 1.3
  • Fix Version/s: None
  • Component/s: None
  • Labels:
    None
  • Patch:
    Code

Description

(defn resolve
"same as (ns-resolve ns symbol) or (ns-resolve ns &env symbol)"

The ampersand on "&env" in the doc string is distracting. There's no macro magic involved so it should just say "env".

Activity

Hide
Stuart Sierra added a comment -

The only way to access local environments in Clojure is with the special &env argument in a macro, so the use of &env in the ns-resolve docstring makes sense.

Declined.

Show
Stuart Sierra added a comment - The only way to access local environments in Clojure is with the special &env argument in a macro, so the use of &env in the ns-resolve docstring makes sense. Declined.
Hide
Andy Fingerhut added a comment -

There are earlier uses of &form and &env in core.clj, but they are all in bootstrap code and none of them become visible in doc strings. There are no other occurrences of & in resolve or ns-resolve, so it seems reasonable to remove it from resolve's doc string.

Patch applies cleanly to latest master as of Feb 24, 2012.

Show
Andy Fingerhut added a comment - There are earlier uses of &form and &env in core.clj, but they are all in bootstrap code and none of them become visible in doc strings. There are no other occurrences of & in resolve or ns-resolve, so it seems reasonable to remove it from resolve's doc string. Patch applies cleanly to latest master as of Feb 24, 2012.

People

Vote (0)
Watch (2)

Dates

  • Created:
    Updated:
    Resolved: