[#CLJ-818] doc string for resolve mentions &env - Clojure JIRA

Details

Type: Enhancement
Status: Closed
Priority: 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".

More Options
- Sort By Name
- Sort By Date
- Ascending
- Descending
- Download All

Attachments

clj-818-resolve-doc-string-patch.txt

24/Feb/12 11:20 AM

0.8 kB

Andy Fingerhut

Activity

Ascending order - Click to sort in descending order

Hide

Permalink

Andy Fingerhut added a comment - 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.

Show

Andy Fingerhut added a comment - 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.

Andy Fingerhut made changes - 24/Feb/12 11:20 AM

Field	Original Value	New Value
Attachment		clj-818-resolve-doc-string-patch.txt [ 10956 ]

Andy Fingerhut made changes - 24/Feb/12 11:21 AM

Patch

Code [ 10001 ]

Hide

Permalink

Stuart Sierra added a comment - 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.

Show

Stuart Sierra added a comment - 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.

Stuart Sierra made changes - 23/Mar/12 8:41 AM

Resolution		Declined [ 2 ]
Status	Open [ 1 ]	Resolved [ 5 ]

Stuart Halloway made changes - 01/Mar/13 12:47 PM

Status

Resolved [ 5 ]

Closed [ 6 ]

People

Assignee:

Unassigned

Reporter:

Steve Miner

Vote (0)

Watch (2)

Dates

Created:

07/Jul/11 2:55 PM

Updated:

01/Mar/13 12:47 PM

Resolved:

23/Mar/12 8:41 AM