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(769): various issues with godoc documents #771

Merged
merged 1 commit into from
Apr 2, 2020

Conversation

maximilien
Copy link
Contributor

Description

Fixes various godoc comments that are not conforming as well as some /lint issues that came up

Changes

  • correct signatures for some functions with with non-conforming names
  • various corrections to Godoc comments for exported code in new lib/test
  • fix CHANGELOG.doc for new location for common test code

Reference

Fixes #769

/lint

@googlebot googlebot added the cla: yes Indicates the PR's author has signed the CLA. label Apr 1, 2020
Copy link
Contributor

@knative-prow-robot knative-prow-robot left a comment

Choose a reason for hiding this comment

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

@maximilien: 0 warnings.

In response to this:

Description

Fixes various godoc comments that are not conforming as well as some /lint issues that came up

Changes

  • correct signatures for some functions with with non-conforming names
  • various corrections to Godoc comments for exported code in new lib/test
  • fix CHANGELOG.doc for new location for common test code

Reference

Fixes #769

/lint

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.

@knative-prow-robot knative-prow-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Apr 1, 2020
@maximilien
Copy link
Contributor Author

/ok-to-test
/assign @navidshaikh

@knative-prow-robot knative-prow-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Apr 1, 2020
Copy link
Collaborator

@navidshaikh navidshaikh left a comment

Choose a reason for hiding this comment

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

/lgtm

@@ -33,7 +33,7 @@ type Kn struct {
namespace string
}

// New Kn object
// NewKn object
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
// NewKn object
// NewKn creates a new Kn object

@@ -68,7 +68,7 @@ func (test *KnTest) Teardown() error {
return DeleteNamespace(test.namespace)
}

// Teardown clean up
// Kn object used by this KnTest
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
// Kn object used by this KnTest
// Kn returns object used by this KnTest

Comment on lines -110 to 113
validateUserId(t, it, r, "svc6", uid)
validateUserID(t, it, r, "svc6", uid)
serviceUpdate(t, it, r, "svc6", "--user", strconv.FormatInt(uid+1, 10))
validateUserId(t, it, r, "svc6", uid+1)
validateUserID(t, it, r, "svc6", uid+1)
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

👍

@@ -50,7 +50,7 @@ func TestSourceApiServer(t *testing.T) {
r := test.NewKnRunResultCollector(t)
defer r.DumpIfFailed()

setupForSourceApiServer(t, it)
setupForSourceAPIServer(t, it)
Copy link
Collaborator

Choose a reason for hiding this comment

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

👍

@knative-prow-robot knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Apr 2, 2020
@knative-prow-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: maximilien, navidshaikh

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:
  • OWNERS [maximilien,navidshaikh]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@knative-prow-robot knative-prow-robot merged commit e524610 into knative:master Apr 2, 2020
coryrc pushed a commit to coryrc/client that referenced this pull request May 14, 2020
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. cla: yes Indicates the PR's author has signed the CLA. lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

test: fix typos/docstrings
4 participants