clojure / clojure/clojure-site

Explain Java terminology before using it

Open
#543 0 comments 0 reactions 1 assignee View on GitHub

@puredanger is already working on this.

Since Aug 17, 2021.

Dominant language
HTML
Stars
259
Forks
275
PR merge metrics
No merged PRs in 30d

Description

The Deps and CLI Guide and the Using Libs Reference both talk about classpaths without ever introducing what they are or what they mean. In fact, not a lot of the interfacing between Java and Clojure is explained except a little in the Deps and CLI glossary.

@seancorfield pointed to me this really, really excellent guide he made that explains these concepts much more clearly and succinctly than I've seen it explained before. A lot of this has been a complete mystery to me and now I feel like I have somewhat of a grasp on it and I can't tell you how valuable that is.

I've been developing in Clojure professionally for a couple years now and I've never had to know these things (since I have a team with people who generally handle this bit) but having it in such an accessible format would have meant I would have picked it up a lot sooner. 😅

This seems like a classic case of the Curse of Knowledge and a huuuuuuge opportunity to improve the Clojure docs! I'd love to see this integrated into the site somewhere!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.