clojure-site icon indicating copy to clipboard operation
clojure-site copied to clipboard

Document the collection class/interface hierarchy

Open Bronsa opened this issue 9 years ago • 7 comments

How is anyone supposed to know that PersistentQueue exists? How is anyone supposed to know what a clojure.lang.MapEntry or a clojure.lang.ISeq are? Note that parts of the documentation and some docstrings explicitely mention some of the collection interfaces but nowhere are they documented or even just listed.

Bronsa avatar Nov 25 '15 13:11 Bronsa

I'll have to talk to Rich about the proper format for this but I'm in full support of expanding documentation for this.

puredanger avatar Nov 25 '15 14:11 puredanger

Here's hoping we'll be able to close this 7yo ticket http://dev.clojure.org/jira/browse/CLJ-19

Bronsa avatar Dec 09 '15 17:12 Bronsa

:+1: I'd be delighted to help out with this if we get a goahead.

arrdem avatar Dec 09 '15 17:12 arrdem

@arrdem This one will probably be me, thanks.

puredanger avatar Dec 09 '15 17:12 puredanger

@puredanger of course. All I can do is offer help.

arrdem avatar Dec 09 '15 18:12 arrdem

I'm looking forward to this and would be happy to offer a pair of eyes to at least read and review anything from the perspective of someone relatively new to Clojure.

pkobrien avatar Jan 07 '16 13:01 pkobrien

I did some updates to Clojure 1.10.1 to Chouser's clojure-classes repository here https://github.com/Chouser/clojure-classes in my fork here: https://github.com/jafingerhut/clojure-classes

The automatically generated graph here is probably a bit too "busy" for high quality publishing, but it is readable for those who want to take the time to pore over it. Here are a few variants with different restrictions on edge "shapes":

  • https://github.com/jafingerhut/clojure-classes/blob/master/generate/graph-1.10.1-ortho.svg
  • https://github.com/jafingerhut/clojure-classes/blob/master/generate/graph-1.10.1-polyline.svg
  • https://github.com/jafingerhut/clojure-classes/blob/master/generate/graph-1.10.1.svg

jafingerhut avatar Nov 15 '20 01:11 jafingerhut