While reading API docs for clojure.test
I noticed some docstring staleness/vagueness and felt it might be helpful to report it here.
The current docstring for clojure.test/report includes the text:
See the documentation at the top of test_is.clj for more information
on the types of arguments for 'report'.
The source file test_is.clj
became test.clj
some time ago.
I think the docstring is probably referring to this.
Maybe instead something like?:
See namespace docs under "EXTENDING TEST-IS" for types of arguments for report
.
Note also that the namespace docstring is a bit on the vague side asking the reader to:
For additional event types, see the examples in the code.
As a reader, I'm not sure where to look for these examples.