Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the collection class/interface hierarchy #17

Open
Bronsa opened this issue Nov 25, 2015 · 7 comments
Open

Document the collection class/interface hierarchy #17

Bronsa opened this issue Nov 25, 2015 · 7 comments
Assignees
Labels

Comments

@Bronsa
Copy link
Member

Bronsa commented Nov 25, 2015

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.

@puredanger
Copy link
Member

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

@Bronsa
Copy link
Member Author

Bronsa commented Dec 9, 2015

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

@arrdem
Copy link
Member

arrdem commented Dec 9, 2015

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

@puredanger
Copy link
Member

@arrdem This one will probably be me, thanks.

@arrdem
Copy link
Member

arrdem commented Dec 9, 2015

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

@pkobrien
Copy link

pkobrien commented Jan 7, 2016

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.

@puredanger puredanger self-assigned this Feb 22, 2016
@jafingerhut
Copy link
Contributor

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":

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants