<< Back to previous view

[CTYP-41] Update docstrings for check-ns and cf to make proper usage explicit (REPL only for check-ns, no recursive use for cf) Created: 03/Sep/13  Updated: 25/Sep/13  Resolved: 03/Sep/13

Status: Closed
Project: core.typed
Component/s: None
Affects Version/s: 0.2.0
Fix Version/s: None

Type: Enhancement Priority: Minor
Reporter: Ethan Sherbondy Assignee: Ambrose Bonnaire-Sergeant
Resolution: Completed Votes: 0
Labels: None


 Description   

When I first tried to use check-ns, I assumed incorrectly that it could be called from within a source file.
I was led to believe this from the example here: https://github.com/clojure/core.typed/wiki/User-Guide#var-warnings
Where (check-ns), although being commented out, is included in the code of a snippet which looks like a file.

Tweaking the docstring for check-ns to state that the function is intended for use from the REPL would probably reduce noobie-flailing.

Also a friendly reminder for you to update the docstring for cf to indicate that it should not be called recursively.

Thanks!



 Comments   
Comment by Ambrose Bonnaire-Sergeant [ 03/Sep/13 11:34 AM ]

Fixed in master.

Documentation fix: https://github.com/clojure/core.typed/commit/343d372ab9e21499a1471f04fb52d25f5d527408

User guide fix: https://github.com/clojure/core.typed/wiki/_compare/36fab1f123d4ce10c287e4956b2a482ae6df68cc...b7be5ee7fdaa68a51f3d1cc14aa443cbbcb28768

Generated at Sat Nov 22 12:01:15 CST 2014 using JIRA 4.4#649-r158309.