Small docstring fix for *' and +'

61 views
Skip to first unread message

Mark Simpson

unread,
Jun 27, 2015, 10:36:35 PM6/27/15
to clojure-dev

I noticed that the functions *' and +' have a tiny problem in their doc
strings. I tried to search for an existing issue in JIRA for did not
find anything.

The issue with the doc strings is that they document the result of
calling * and + without arguments *not* the result of calling *' and +'
in that case. Am I correct in interpreting this as a small problem with
the documentation?

If this is a problem, what is the next step? Create a JIRA ticket with a
patch attached? (I have already submitted the Contributor Agreement).

Thanks in advance

Ciao
Mark Simpson

p.s. Here is the patch I just created in case anyone is interested to
see it.

patch.txt

Alex Miller

unread,
Jun 27, 2015, 10:43:34 PM6/27/15
to cloju...@googlegroups.com
Jira and patch is fine.
> --
> You received this message because you are subscribed to the Google Groups "Clojure Dev" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to clojure-dev...@googlegroups.com.
> To post to this group, send email to cloju...@googlegroups.com.
> Visit this group at http://groups.google.com/group/clojure-dev.
> For more options, visit https://groups.google.com/d/optout.
> commit a622f9c81cb617a9a54ff84992e63f877f0764ff Author: Mark Simpson Date: Sat Jun 27 15:19:21 2015 -0400 Small correction to *' and +' doc strings diff --git a/src/clj/clojure/core.clj b/src/clj/clojure/core.clj index a18543c..b8eab2d 100644 --- a/src/clj/clojure/core.clj +++ b/src/clj/clojure/core.clj @@ -935,7 +935,7 @@ (defn ^:private >0? [n] (clojure.lang.Numbers/gt n 0)) (defn +' - "Returns the sum of nums. (+) returns 0. Supports arbitrary precision. + "Returns the sum of nums. (+') returns 0. Supports arbitrary precision. See also: +" {:inline (nary-inline 'addP) :inline-arities >1? @@ -959,7 +959,7 @@ (reduce1 + (+ x y) more))) (defn *' - "Returns the product of nums. (*) returns 1. Supports arbitrary precision. + "Returns the product of nums. (*') returns 1. Supports arbitrary precision. See also: *" {:inline (nary-inline 'multiplyP) :inline-arities >1?
Reply all
Reply to author
Forward
0 new messages