Skip to content
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

Closed
martinklepsch opened this issue Nov 13, 2018 · 3 comments · Fixed by #26
Closed

Set metadata to identify inlined namespaces #19

martinklepsch opened this issue Nov 13, 2018 · 3 comments · Fixed by #26
Milestone

Comments

@martinklepsch
Copy link

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

@martinklepsch martinklepsch changed the title Set :no-doc metadata for inlined namespaces Set metadata to identify inlined namespaces Nov 13, 2018
@bbatsov
Copy link

bbatsov commented Nov 13, 2018

It'd be nice if it also added something like :inlined, so tools could infer which namespaces are "private" vs "inlined".

@benedekfazekas
Copy link
Owner

by private you mean belonging to the the library not a dependency, or you mean something else?

@martinklepsch
Copy link
Author

@benedekfazekas I think by "private" Bozhidar might refer to namespaces annotated with :no-doc. I think if you'd add something like:mranderson/inlined-ns to namespaces as metadata all requests would be accounted for. cljdoc would simply filter namespaces based on that and other users could easily identify "external" namespaces by checking if that key is present in the namespace's metadata.

@benedekfazekas benedekfazekas added this to the 0.5.0 milestone Mar 19, 2019
benedekfazekas added a commit that referenced this issue Mar 19, 2019
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants