-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
📖 improve builder deprecation messages #352
📖 improve builder deprecation messages #352
Conversation
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. |
please sign the CLA, otherwise looks good. Thanks! |
@DirectXMan12 Waiting on the 👍 for that. Will poke the bot after it gets resolved. |
55bafe5
to
ac7d3d3
Compare
It's convention in the Go community that a function's deprecation notice is separated by a new paragraph from the function's documentation. Tools like staticcheck determine if a function has been deprecated by checking the beginning of new paragraphs. This changelist modifies the deprecation notices in the builder package to follow this convention, allowing linters like staticcheck, gometalinter, and golangci-lint to warn users of the package.
ac7d3d3
to
cd52b04
Compare
/lgtm Thanks! |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: DirectXMan12, terinjokes 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 |
improve contributing guide
It's convention in the Go community that a function's deprecation notice
is separated by a new paragraph from the function's documentation. Tools
like staticcheck determine if a function has been deprecated by checking
the beginning of new paragraphs.
This changelist modifies the deprecation notices in the builder package
to follow this convention, allowing linters like staticcheck,
gometalinter, and golangci-lint to warn users of the package.