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.

Sign up for GitHub

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

Jump to bottom

Consider adding :no-doc under common metadata #221

Closed
lread opened this issue Mar 17, 2021 · 2 comments · Fixed by #224
Closed

Consider adding :no-doc under common metadata #221

lread opened this issue Mar 17, 2021 · 2 comments · Fixed by #224

Comments

@lread
Copy link
Contributor

lread commented Mar 17, 2021

The :no-doc metadata is a signal to documentation tools like Codox and cljdoc that a namespace or var within a namespace should not be included as part of the public API.

If this makes sense to folks, happy to do up a PR.
@lread lread changed the title Consider adding :no-doc under common metadata Consider adding :no-doc under common metadata Mar 17, 2021
@bbatsov
Copy link
Owner

bbatsov commented Mar 17, 2021

PR welcome!

@lread
Copy link
Contributor Author

lread commented Mar 17, 2021

Will do!

lread added a commit to lread/clojure-style-guide that referenced this issue Mar 17, 2021
@lread
Describe :no-doc metadata
96369e3 
Closes bbatsov#221
@lread lread mentioned this issue Mar 17, 2021
Merged
bbatsov pushed a commit that referenced this issue Mar 18, 2021
@lread
[Fix #221] Describe :no-doc metadata (#224)
fede2c5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Describe :no-doc metadata lread/clojure-style-guide
2 participants
@bbatsov @lread