-
Notifications
You must be signed in to change notification settings - Fork 14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Set metadata to identify inlined namespaces #19
Comments
:no-doc
metadata for inlined namespaces
It'd be nice if it also added something like |
by private you mean belonging to the the library not a dependency, or you mean something else? |
@benedekfazekas I think by "private" Bozhidar might refer to namespaces annotated with |
watermark is ommitted for the project's own source files. Defaults to `:mranderson/inlined` can be overriden via `mranderson` section in the project file. To opt out set watermark to nil.
Tools like https://cljdoc.org that generate API documentation will see inlined deps namespaces like any other namespace. This makes it hard to exclude namespaces from inlined dependencies from API documentation; making the API docs harder to read for end users.
It would be great of MrAnderson could attach some metadata to inlined namespaces so that those namespaces can be identified and excluded from API documentation. Perhaps just
:no-doc
is fine but something more MrAnderson specific would also be reasonable and useful enough.Here's an example of how this affects the cider-nrepl API docs.
cljdoc/cljdoc#195
The text was updated successfully, but these errors were encountered: