clojure / clojure/clojure-site

Document `do` behavior at top-level

Open Beginner friendly
#723 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Per https://ask.clojure.org/index.php/14628/consider-documenting-usage-of-do-for-the-gilardi-scenario

Document that do special form at the top-level evaluates its body as separate top-level forms.

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.

Research direction

Start with the Clojure documentation for the do special form and review the linked ask.clojure.org discussion for the intended GILARDI scenario. Document that a top-level do evaluates its body as separate top-level forms, and verify that the wording clearly distinguishes this behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.