-
Notifications
You must be signed in to change notification settings - Fork 15.4k
Issue with k8s.io/docs/concepts/overview/working-with-objects/names/ #16141
Description
Problem:
The wording:
All objects in the Kubernetes REST API are unambiguously identified by a Name and a UID.
is a bit unclear.
The wording isn't ambiguous between the meanings:
- each object is unambiguously identified by a Name and is unambiguously identified by a UID,
- each object is unambiguously identified by the combination of a Name and a UID.
Also, mixing plural "objects" with a characteristic of each object (e.g., "a name") is a bit ambiguous or confusing too.
(Yes, readers can probably figure it out, but let's be clear to start with, so that readers don't have to slow down to resolve the ambiguity and can proceed with absorbing what the documentation is trying to tell them.)
Proposed Solution:
State more clearly what is intended to be conveyed.
The cardinalities would be much clearer if that text referred to "each object", as in:
Each object in the Kubernetes REST API is unambiguously identified by ...
Page to Update:
https://kubernetes.io/...