Fill and correct 2.0 documentation gaps#4100
Merged
Merged
Conversation
Two 2.0 features shipped without manual coverage. Add a Tap Viewer page (wired into the nav) describing cider-tap, its buffer commands, the ClojureScript caveat, and the tap-a-form helpers; and a "Running ClojureScript Tests" section covering the cljs.test support and its cider-nrepl requirement.
The keybinding docs still described the pre-transient world: the jack-in chords were documented as `C-c C-x C-j C-j` etc., but `C-c C-x` now opens the `cider-start-menu` transient, so only its suffixes (`j j`, `c j`, ...) work. Fix that section, note that `C-c M-m` is a transient, and add the REPL's new bindings (`C-c M-m`, `C-c C-x`, `C-c C-h`, and the `C-x C-e` no-op). Also fix two factual drifts: the documented `cider-repl-history-size` default (now 5000, was 500) and a CHANGELOG entry still naming the pre-rename `cider-use-fringe-indicators`.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation follow-ups found during the 2.0 review.
New feature coverage:
cider-tap- the streaming buffer, its keybindings, the ClojureScript "can't inspect" caveat, and the tap-a-form helpers.cljs.testtests against a ClojureScript REPL.Accuracy fixes:
C-c C-x C-j C-jand friends, butC-c C-xnow opens thecider-start-menutransient, so those chords don't work - only the transient suffixes (j j,c j, ...) do. Reframed that section, notedC-c M-mis a transient too, and added the REPL's new bindings.cider-repl-history-size's documented default (now 5000) and a CHANGELOG entry still using the pre-renamecider-use-fringe-indicators.