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

Supporting standard --- convention for comments to not be included in public APIs #93

Open
naemono opened this issue Aug 23, 2024 · 0 comments
Open

Supporting standard --- convention for comments to not be included in public APIs #93

naemono opened this issue Aug 23, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@naemono
Copy link

naemono commented Aug 23, 2024

We recently had a PR elastic/cloud-on-k8s#8020 where we wanted to include a comment in a public CRD, but didn't want it to be included in the public-facing API docs. It seems that the controller-tools supports using --- to preface comments to not be included. I think this tooling may want to support this as well to be consistent.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@naemono