📖 Improve docs for client.Object #1231
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It was brought to my attention that the relationship between client.Object and runtime.Object isn't particularly clear to folks who are not used to working in the guts of client-go & apimachinery, so this adds some docs to helpfully clarify and provide examples.
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
approved
|
cc @cflewis |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: alvaroaleman, cflewis, DirectXMan12 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 |
|
@DirectXMan12 sidenote, do you think we should try to uptstream these two interfaces to make them a bit more official? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It was brought to my attention that the relationship between
client.Object and runtime.Object isn't particularly clear to folks who
are not used to working in the guts of client-go & apimachinery, so this
adds some docs to helpfully clarify and provide examples.