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

📖 improve builder deprecation messages #352

Conversation

terinjokes
Copy link
Contributor

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.

@k8s-ci-robot
Copy link
Contributor

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.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Mar 6, 2019
@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 6, 2019
@DirectXMan12
Copy link
Contributor

please sign the CLA, otherwise looks good. Thanks!

@terinjokes
Copy link
Contributor Author

@DirectXMan12 Waiting on the 👍 for that. Will poke the bot after it gets resolved.

@terinjokes terinjokes force-pushed the patches/builder-deprecation-notices branch from 55bafe5 to ac7d3d3 Compare March 7, 2019 19:42
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.
@terinjokes terinjokes force-pushed the patches/builder-deprecation-notices branch from ac7d3d3 to cd52b04 Compare March 7, 2019 21:11
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Mar 9, 2019
@DirectXMan12
Copy link
Contributor

/lgtm
/approve

Thanks!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 9, 2019
@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 9, 2019
@k8s-ci-robot k8s-ci-robot merged commit 1dafd94 into kubernetes-sigs:master Mar 9, 2019
DirectXMan12 pushed a commit that referenced this pull request Jan 31, 2020
@terinjokes terinjokes deleted the patches/builder-deprecation-notices branch November 14, 2022 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants