<< Back to previous view

[CLJ-818] doc string for resolve mentions &env Created: 07/Jul/11  Updated: 01/Mar/13  Resolved: 23/Mar/12

Status: Closed
Project: Clojure
Component/s: None
Affects Version/s: Release 1.3
Fix Version/s: None

Type: Enhancement Priority: Trivial
Reporter: Steve Miner Assignee: Unassigned
Resolution: Declined Votes: 0
Labels: None

Attachments: Text File clj-818-resolve-doc-string-patch.txt    
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".

 Comments   
Comment by Andy Fingerhut [ 24/Feb/12 11:20 AM ]

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.

Comment by Stuart Sierra [ 23/Mar/12 8:41 AM ]

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.

Generated at Thu Jun 20 07:06:17 CDT 2013 using JIRA 4.4#649-r158309.