Clojure JIRA

[MTOWER-1] README should be updated to conform to contrib standard

Mon, 17 Sep 2012 11:33:44 -0500

As per Sean Corfield's suggestion here: https://groups.google.com/forum/?fromgroups=#!searchin/clojure-dev/math/clojure-dev/p5oz42gR_sk/cesMHO9cDWEJ
the math.numeric-tower README.md should be updated to be more useful, especially to newbies.

[MCOMB-1] math.combinatorics README should be updated to conform to contrib standard

Mon, 17 Sep 2012 11:35:57 -0500

As per Sean Corfield's suggestion here: https://groups.google.com/forum/?fromgroups=#!searchin/clojure-dev/math/clojure-dev/p5oz42gR_sk/cesMHO9cDWEJ
the math.combinatorics README.md should be updated to be more useful, especially to newbies.

[LOGIC-131] Docstrings for lvaro and nonlvaro need improvement.

Tue, 7 May 2013 22:29:08 -0500

Assuming the following definitions:

1. A term is ground if it does not contain unassociated logic variables.
2. Otherwise, it is non-ground.

My suggestions:

lvaro: A non-relational goal that succeeds if the supplied logic variable is fresh.

nonlvaro: A non-relational goal that succeeds if the supplied logic variable is not fresh.

In the case nonlvaro, it's important to recognize that the implementation only tests whether the supplied lvar is not fresh, and "not fresh" != grounded; the result could be partially instantiated. For example, nonlvaro succeeds here when its argument is neither fresh nor grounded:

(run* [q]
  (fresh [x]
    (== q [x])
    (nonlvaro q)))
;; => ([_0])

[LOGIC-33] Added usage section to readme.md

Sun, 17 Mar 2013 19:11:55 -0500

added a short usage section in readme.md

the latest working repo was 0.6.7 for me, so that's what in the patch. (i have signed CA)

[DCSV-3] Some minor documentation typos

Fri, 15 Jun 2012 08:51:58 -0500

I found a couple minor typos: one in the README, one in a docstring. I've included a patch.

[CMEMOIZE-2] Deprecate Unk

Tue, 13 Dec 2011 07:58:35 -0600

core.memoize was originally Unk , but its inclusion into contrib means the latter is redundant. The Unk repo should indicate the move and change to a place for docs and examples. Likewise, a formal announcement should be made.

[CLJS-392] Documentation says CLJS can open connections to the REPL server from a "file://" source, and you can't

Wed, 24 Oct 2012 14:48:48 -0500

At https://github.com/clojure/clojurescript/wiki/The-REPL-and-Evaluation-Environments there is the following paragraph:

"This is a problem for the browser-connected REPL because FireFox and Chrome both view opening a file from the file system and connecting to localhost:9000 as different domains.
(...)
Fortunately, Google has also run into this problem and has created something called a CrossPageChannel. Without going into the details, this allows an iframe served from one domain (the REPL) to communicate with the parent page which was served from another domain (the application server)."

From what I tested, you CANT connect to the REPL server at "http://localhost:9000/repl" if you initially loaded the page using the "file://" protocol. But you can if you loaded it from the same hostname on another port using "http://". The documentation is wrong, and also it needs to be clarified on what you really can change from the initial domain, like the port, without broking the REPL connection (or link to a CrossPageChannel documentation page with the details on what same-origin policy checks it can overcome).

[CLJS-186] ClojureScript wiki/The-REPL-and-Evaluation-Environments - small issues

Wed, 30 May 2012 16:26:07 -0500

I just worked through the "The REPL and Evaluation Environments" wiki page and had to make the following change to get the example to work.

— The-REPL-and-Evaluation-Environments.md.0 2012-04-19 17:40:23.000000000 -0400
+++ The-REPL-and-Evaluation-Environments.md 2012-04-19 17:40:48.000000000 -0400
@@ -57,6 +57,7 @@
<body>
<div id="content">
<script type="text/javascript" src="out/goog/base.js"></script>
+ <script type="text/javascript" src="out/goog/deps.js"></script>
<script type="text/javascript" src="foo.js"></script>
<script type="text/javascript">
goog.require('foo');

Something else I noticed was that I didn't get the "Starting server on port 9000" message.

[CLJ-1038] Docstring for deliver doesn't match behavior

Fri, 1 Mar 2013 12:47:10 -0600

The docstring for deliver doesn't match the actual behavior. It says an exception gets thrown on multiple delivers, but that's no longer the case, as of 1.3 (hat tip to clgv on irc).

user=> (doc deliver)
-------------------------
clojure.core/deliver
([promise val])
  Alpha - subject to change.
  Delivers the supplied value to the promise, releasing any pending
  derefs. A subsequent call to deliver on a promise will throw an exception.
nil

(let [p (promise)] 
  (deliver p "hi") 
  (deliver p "bye") 
  @p)
;=> "hi"

This patch updates the docstring to reflect actual behavior: "will throw an exception." -> "will have no effect."

[CLJ-1027] Outdated documentation for gen-class's :exposes-methods option

Wed, 18 Jul 2012 19:01:35 -0500

The docstring for gen-class says the following regarding the :exposes-methods option:

"It is sometimes necessary to call the superclass' implementation of an
overridden method. Those methods may be exposed and referred in
the new method implementation by a local name."

To me, this suggests that supplying something like `{foo fooSuper}` allows me to use the symbol `fooSuper` in my new method implementation. Doing this actually results in an error while compiling because `fooSuper` cannot be resolved. It seems that what actually happens is that a `fooSuper` instance method is defined, which calls the superclass's implementation. The docstring should be updated to reflect this.

[CLJ-1019] ns-resolve doc has a typo

Sat, 18 Aug 2012 07:12:52 -0500

The doc string for ns-resolve has a typo: environement should be environment.

[CLJ-999] Wrong link in gh-pages index (api-index.html)

Mon, 20 May 2013 16:24:12 -0500

The api-index.html includes wrong links for the following:

All entries for all listed as part of clojure.test.tap
All entries for all listed as part of clojure.test.junit
All entries for all listed as part of clojure.core.protocols

The links point to pages that do not exist. The problem is that the documentation for those entries is on a "parent" page, for example, the link clojure.core.protocols-api.html#clojure.core.protocols/internal-reduce should have been clojure.core-api.html#clojure.core.protocols/internal-reduce

Not a huge bug for me, but you might want to get it fixed.

And please give my huge thanks to whoever is in charge of the documentation, I'm the developer behind Dash, a Mac OS X documentation browser, and I was in the process of creating a documentation set for Clojure, and because you guys have an index, you made my work 1000 times easier.

[CLJ-998] doc string for replace-first mentions non-existent replace-all

Fri, 1 Mar 2013 12:47:10 -0600

The doc string for clojure.string/replace-first says see also replace-all, which does not exist. The actual function is simply 'replace'.

[CLJ-980] Documentation for extend-type falsely implies that & is allowed in protocol fn signatures

Wed, 19 Dec 2012 08:00:13 -0600

The documentation for extend-type contains the following example:

(extend-type MyType 
    Countable
      (cnt [c] ...)
    Foo
      (bar [x y] ...)
      (baz ([x] ...) ([x y & zs] ...)))

However, [x y & zs] is not a valid parameter list for a protocol fn. The documentation should be appropriately amended.

[CLJ-973] doc for data-readers is wrong about the format for data_readers.clj

Sat, 14 Apr 2012 13:52:46 -0500

Sometime recently, the format for data_readers.clj changed to require a read-time literal map instead of pairs of symbols. The doc string for *data-readers* should be updated to reflect the change.

[CLJ-965] clojure.org/patches should have link to JIRA workflow wiki page added, and most content removed

Thu, 10 May 2012 20:49:44 -0500

http://groups.google.com/group/clojure-dev/browse_frm/thread/12e90e460aec29cb

Relevant text supporting this suggestion copied below:

[1] http://dev.clojure.org/display/design/JIRA+workflow

Only a few have permission to edit this page:

[2] http://clojure.org/patches

I have carefully reviewed the content of those two side by side, section by section, and it seems to me that they are either identical, or [1] is more up to date.

I am not proposing getting rid of [2], but instead do this:

Keep the first section headed "Submitting patches to Clojure and Clojure Contrib" exactly as it is now.

Immediately under the heading "So You Have an Idea...", put a single link, perhaps with one sentence or phrase, that points at [1]. Delete all other text from there down on [2]. You will lose nothing worth saving, and you will save future confusion as what is now [2] gets more and more stale.

[CLJ-953] drop-while doc string wrong, nil instead of logical false

Fri, 30 Mar 2012 09:16:31 -0500

"Returns a lazy sequence of the items in coll starting from the first
-  item for which (pred item) returns nil."
+  item for which (pred item) returns logical false."

[CLJ-936] Improve docs about argument destructuring at clojure.org

Fri, 1 Mar 2013 09:49:21 -0600

What:
Make the description of argument destructuring more visible at http://clojure.org/special_forms, namely:

add a heading such as "<h4>Binding Forms (Argument Destructuring)</h4>" to the section describing it
make all occurences of "binding-form" a link to that heading, especially under the let and fn headings
for (fn ..) add a new second paragraph like "Regarding binding forms, also known as argument destructuring, <a href=#thea-new-heading>read more in the binding forms section</a> under the let special form."

Why:
It was always surprisingly difficult for me to google out the explanation of destructuring in Clojure and only today have I discovered that it is described pretty well under the let special form. Thus it should be made more visible to the readers (and preferably also search engines). (Even though Google has returned the page as one of the first matches, I had problems seeing it there - partly due to usually mistyping destructuring e.g. as deconstruction).

Thanks a lot!

PS: I haven't found a better way to report this, such as a commenting capability on the page itself.

[CLJ-917] clojure.core/definterface is not included in the API docs

Sat, 20 Oct 2012 09:53:42 -0500

Is definterface meant to be a public API? If yes, then it needs a docstring.

[CLJ-900] Document defonce-like behavior of defmulti

Mon, 19 Dec 2011 16:40:59 -0600

Since Clojure 1.2 defmulti behaves similarly to defonce. This fact, and how one deals with it when doing interactive development, does not seem to be documented anywhere. This issue pops up fairly regularly in the #clojure channel.

Commit that introduced the change: https://github.com/clojure/clojure/commit/1b8d5001ba094053b24c55829994785be422cfbf

I can volunteer to update the docstrings and (if I get access to it) the clojure.org page.

[CCACHE-13] Deprecate Clache

Tue, 14 Aug 2012 20:34:42 -0500

core.cache was originally Clache , but its inclusion into contrib means the latter is redundant. The Clache repo should indicate the move and change to a place for docs and examples. Likewise, a formal announcement should be made.