Note that the `ns` field is Clojure-flavored, kept for compatibility

Open Beginner friendly
#5 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
clojure
Domain
documentation

Research direction

Start with the specification sections for eval and completions, where the ns field is described. Clarify that ns is retained for compatibility and is not intended as a language-neutral naming recommendation; done means both sections communicate that decision consistently.

Written by the indexing model from the issue text.

Description

@alexander-yakushev pointed out that using ns as a generic module/namespace key in eval and completions "reeks Clojure" and undermines the language-agnostic framing of the protocol. @technomancy agreed that a more neutral name would fit better if starting from scratch, but asked whether it's worth breaking compatibility. @alexander-yakushev replied no.

Effectively settled as "keep ns for compatibility", but the spec should say that explicitly so future readers don't read the choice as a recommendation.

My take:

  • I'm fine with keeping ns as is. Perhaps down the road we can add a more generic property (namespace, module, etc.) as an alias for it.
  • In general I think whatever we pick initially should be fairly close to what we currently have in the wild and build on top of it (as that'd be the least painful path).
Dominant language
HTML
Stars
2
Forks
1
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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.

More from nrepl/spec.nrepl.org

All issues in nrepl/spec.nrepl.org

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.