Correcting a docstring mistake in clojure.core/filter

107 views
Skip to first unread message

Alan Thompson

unread,
Sep 24, 2016, 8:16:02 PM9/24/16
to Clojure
Hi Alex - What is the best way to correct a mistake in the docstring for clojure.core/filter? 

The existing docstring is:

​​
Returns a lazy sequence of the items in coll for which
(pred item) returns true. pred must be free of side-effects.
Returns a transducer when no collection is provided.

​I would like to correct it to read:

Returns a lazy sequence of the items in coll for which
(pred item)
​ ​
​returns a 
truthy
​ 
value 
(neither false nor nil). pred must be 
free of side-effects.
​ 
Returns a transducer when no collection is provided.

​The need for this is illustrated by a quick check:

> (filter identity [:a 1 true false nil "done"])
(:a 1 true "done")

Alan

Daniel Compton

unread,
Sep 25, 2016, 6:52:03 PM9/25/16
to Clojure
Opening a ticket on dev.clojure.org, and providing a docstring patch is the standard (and fastest) way to do this.

--
You received this message because you are subscribed to the Google
Groups "Clojure" group.
To post to this group, send email to clo...@googlegroups.com
Note that posts from new members are moderated - please be patient with your first post.
To unsubscribe from this group, send email to
clojure+u...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/clojure?hl=en
---
You received this message because you are subscribed to the Google Groups "Clojure" group.
To unsubscribe from this group and stop receiving emails from it, send an email to clojure+u...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
--

Daniel
Reply all
Reply to author
Forward
0 new messages