Merge pull request #51511 from huangjiuyuan/fix-func-comment

Automatic merge from submit-queue (batch tested with PRs 51298, 51510, 51511) modifying the comment of BeforeDelete function to improve readability **What this PR does / why we need it**: modifying the comment of `BeforeDelete` function in `staging/src/k8s.io/apiserver/pkg/registry/rest/delete.go` to improve readability. **Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: fixes # **Special notes for your reviewer**: **Release note**: `NONE` Kubernetes-commit: ce559394653a8e5041f44d49391b851ec5465538
2017-08-29 10:38:19 -07:00 · 2017-08-29 10:38:19 -07:00 · c68d80e8a2
parent b2a8ad67a0 ce838cffe4
commit c68d80e8a2
2 changed files with 67 additions and 64 deletions
--- a/Godeps/Godeps.json
+++ b/Godeps/Godeps.json
@ -840,235 +840,235 @@
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/api/equality",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/api/errors",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/api/meta",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/api/resource",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/api/testing",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/api/testing/fuzzer",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/api/testing/roundtrip",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/api/validation",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/api/validation/path",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/apimachinery",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/apimachinery/announced",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/apimachinery/registered",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/apis/meta/fuzzer",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/apis/meta/internalversion",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/apis/meta/v1",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/apis/meta/v1/validation",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/apis/meta/v1alpha1",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/conversion",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/conversion/queryparams",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/conversion/unstructured",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/fields",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/labels",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/runtime",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/runtime/schema",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/runtime/serializer",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/runtime/serializer/json",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/runtime/serializer/protobuf",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/runtime/serializer/recognizer",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/runtime/serializer/streaming",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/runtime/serializer/versioning",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/selection",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/types",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/util/cache",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/util/clock",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/util/diff",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/util/errors",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/util/framer",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/util/httpstream",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/util/intstr",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/util/json",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/util/mergepatch",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/util/net",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/util/proxy",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/util/rand",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/util/runtime",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/util/sets",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/util/strategicpatch",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/util/uuid",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/util/validation",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/util/validation/field",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/util/wait",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/util/yaml",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/version",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/pkg/watch",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/third_party/forked/golang/json",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/third_party/forked/golang/netutil",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/apimachinery/third_party/forked/golang/reflect",
-      "Rev": "31421d9f8c2d6073628a89b4654fe22aced33167"
+      "Rev": "b166f81f5c4c88402ae23a0d0944c6ad08bffd3b"
    },
    {
      "ImportPath": "k8s.io/client-go/discovery",
--- a/pkg/registry/rest/delete.go
+++ b/pkg/registry/rest/delete.go
@ -59,12 +59,15 @@ type RESTGracefulDeleteStrategy interface {
 	CheckGracefulDelete(ctx genericapirequest.Context, obj runtime.Object, options *metav1.DeleteOptions) bool
 }

-// BeforeDelete tests whether the object can be gracefully deleted. If graceful is set the object
-// should be gracefully deleted, if gracefulPending is set the object has already been gracefully deleted
-// (and the provided grace period is longer than the time to deletion), and an error is returned if the
-// condition cannot be checked or the gracePeriodSeconds is invalid. The options argument may be updated with
-// default values if graceful is true. Second place where we set deletionTimestamp is pkg/registry/generic/registry/store.go
-// this function is responsible for setting deletionTimestamp during gracefulDeletion, other one for cascading deletions.
+// BeforeDelete tests whether the object can be gracefully deleted.
+// If graceful is set, the object should be gracefully deleted.  If gracefulPending
+// is set, the object has already been gracefully deleted (and the provided grace
+// period is longer than the time to deletion). An error is returned if the
+// condition cannot be checked or the gracePeriodSeconds is invalid. The options
+// argument may be updated with default values if graceful is true. Second place
+// where we set deletionTimestamp is pkg/registry/generic/registry/store.go.
+// This function is responsible for setting deletionTimestamp during gracefulDeletion,
+// other one for cascading deletions.
 func BeforeDelete(strategy RESTDeleteStrategy, ctx genericapirequest.Context, obj runtime.Object, options *metav1.DeleteOptions) (graceful, gracefulPending bool, err error) {
 	objectMeta, gvk, kerr := objectMetaAndKind(strategy, obj)
 	if kerr != nil {