fix wrong description #113868
fix wrong description #113868
Conversation
Signed-off-by: yanggang <gang.yang@daocloud.io>
|
@yanggangtony: Adding the "do-not-merge/release-note-label-needed" label because no release-note block was detected, please follow our release note process to remove it. 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. |
|
Welcome @yanggangtony! |
|
Hi @yanggangtony. Thanks for your PR. I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: yanggangtony The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/triage accepted |
| type Interface interface { | ||
| // Stop stops watching. Will close the channel returned by ResultChan(). Releases | ||
| // Stop watching. Will close the channel returned by ResultChan(). Releases |
There was a problem hiding this comment.
I think this wording was actually intended and correct. According to godoc:
As with packages (above) and funcs (below), doc comments for types start with complete sentences naming the declared symbol. An explicit subject often makes the wording clearer, and it makes the text easier to search, whether on a web page or a command line. For example:
See specifically the example for Sort showing a similar pattern:
package sort
// Sort sorts data in ascending order as determined by the Less method.
// It makes one call to data.Len to determine n and O(n*log(n)) calls to
// data.Less and data.Swap. The sort is not guaranteed to be stable.
func Sort(data Interface) {
...
}|
Given my explanation above that this is likely the intended & correct godoc style, I'll be marking this closed. Please feel free to re-open and discuss further if you believe this is a mistake. /close |
|
@alexzielenski: Closed this PR. In response to this:
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. |
@alexzielenski |
Signed-off-by: yanggang gang.yang@daocloud.io
What type of PR is this?
/kind documentation
Special notes for your reviewer:
Read the codes , but confused with the note message..