[Fix #380] Mark internal helper namespaces with ^:no-doc#426
Merged
Conversation
cljdoc was rendering all 30+ namespaces as if they were public API, which gave the wrong impression about the supported surface. The actual public surface is the namespaces backing the nREPL ops, plus a handful that have been called out in past CHANGELOG entries (config, libspec-allowlist, pprint). Everything else - parsers, trackers, sexp helpers, generic util ns - is plumbing and shouldn't be in the docs. Tag those 12 internal namespaces (plus the already-flagged-as-beta suggest-libspecs) with ^:no-doc on the ns form. cljdoc respects this metadata; downstream tooling like Codox does too. No behavior change.
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.
Fixes #380.
Hides 13 internal helper namespaces from cljdoc via
^:no-docon theirnsforms, leaving the documented surface as the namespaces backing nREPL ops plus a handful that have been called out historically (config,ns.libspec-allowlist,ns.pprint) and a few useful helpers (ns-parser,suggest-aliases,class-search,find-macros,s-expressions).The hidden ones:
core,util,util.meta,fs,find.bindings,find.util,find.symbols-in-file,ns.imports-and-refers-analysis,ns.prune-dependencies,ns.rebuild,ns.tracker,ns.suggest-libspecs(already self-described as beta).Once this lands, @lread the public surface is what's left after this filter — happy to chat further if any of the borderline calls feel wrong.
lein do clean, test)make install-- takes a long time)