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
⚠️ Trim leading/trailing whitespace on lines in documentation #517
Conversation
This is important for input files that use `/*…*/`-style comments, where `go/ast` preserves the leading and trailing (and inner) whitespace and this ends up in the generated CRD schema descriptions.
Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA. It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
Welcome @Porges! |
@k8s-ci-robot have signed CLA |
/assign @droot Please take a look, this is ready for review. |
@droot is there someone else I should be assigning instead? |
/assign @DirectXMan12 perhaps? |
/auto-cc |
The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs. This bot triages issues and PRs according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale |
/remove-lifecycle stale |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/ok-to-test
/label tide/merge-method-squash
Sorry for the long delay. Looks generally good, one small comment. Please also mark the PR as breaking, even if we consider the new behavior an improvement.
Is that simply the |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: alvaroaleman, Porges The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
yep. Thanks for your work! |
/lgtm |
This is important for input files that use
/*…*/
-style comments, wherego/ast
preserves the leading and trailing (and inner) whitespace and this ends up in the generated CRD schema descriptions, where it looks simply silly.Without this change, the new example types
HasDocsWithSpaces
(2
) end up with descriptions with embedded tabs and leading/trailing whitespace.