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

Fix godoc deprecated comments. #6207

Merged
merged 1 commit into from
Mar 1, 2023
Merged

Conversation

wlynch
Copy link
Member

@wlynch wlynch commented Feb 22, 2023

Changes

Fix godoc deprecated comments.

From https://github.com/golang/go/wiki/Deprecated:

To signal that an identifier should not be used, add a paragraph to its doc
comment that begins with "Deprecated:" followed by some information about the
deprecation, and a recommendation on what to use instead, if applicable.

This should help IDEs and pkgsite to pick up on deprecated fields.

Most changes fall into a few categories:

  • "Deprecated." -> "Deprecated:"
  • Added paragraph new line.
  • Added deprecation description.

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Has Docs included if any changes are user facing
  • Has Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including
    functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

@tekton-robot tekton-robot added the release-note-none Denotes a PR that doesnt merit a release note. label Feb 22, 2023
@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 22, 2023
@wlynch
Copy link
Member Author

wlynch commented Feb 22, 2023

/kind documentation

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Feb 22, 2023
From https://github.com/golang/go/wiki/Deprecated:

> To signal that an identifier should not be used, add a paragraph to its doc
> comment that begins with "Deprecated:" followed by some information about the
> deprecation, and a recommendation on what to use instead, if applicable.

Most changes fall into a few categories:
- "Deprecated." -> "Deprecated:"
- Added paragraph new line.
- Added deprecation description.
@wlynch
Copy link
Member Author

wlynch commented Feb 23, 2023

/test pull-tekton-pipeline-alpha-integration-tests

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lbernick

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

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 24, 2023
@JeromeJu
Copy link
Member

/retest

Copy link
Member

@jerop jerop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 28, 2023
@tekton-robot tekton-robot merged commit f0b8c16 into tektoncd:main Mar 1, 2023
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. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesnt merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants