Clojure JIRA

[UNIFY-3] Enhance documentation

Fri, 3 Feb 2012 08:43:25 -0600

The current unify docs are spartan and "just the facts". It would be useful to have a set of docs that:

explain unification
explain the library use cases
show a simple example use

[JDBC-50] insert-rows (incorrectly) patches incomplete records

Sat, 6 Apr 2013 15:38:46 -0500

When using sql/insert-rows with a dataset that contains incomplete rows the rows will be patched with values from the preceding rows. The behaviour to be expected is not documented.

I would expect insert-rows either only accepts complete rows. When accepting incomplete rows I would expect patching with nil-values instead of values from other rows.

Attached you find an example and the output when running in comments.

[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.

[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-387] Add docstring from def and ns definitions to @namespaces metadata map, and make reflect functions make use of that

Wed, 17 Oct 2012 10:57:56 -0500

The docstrings were parsed from the definitions-forms for def and ns, but not added to the @namespaces metadata map.
There is no :doc entry used in the ns' metadata in the @namespaces.
No ns's :doc info is communicated to the browser in the reflect functions with reflect/doc.
Patch-file is attached with code-changes that add the :doc info for ns and def to the @namespaces, and enhances the reflect functions to communicate that info to the browser in the reflect/doc call.

[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-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.