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

Update examples #922

Merged
merged 3 commits into from
Aug 13, 2019
Merged

Conversation

oz123
Copy link
Contributor

@oz123 oz123 commented Aug 8, 2019

This is a partial fix for #884 which addresses the first two bullet points.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 8, 2019
Copy link
Contributor

@micw523 micw523 left a comment

Choose a reason for hiding this comment

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

Do you want to rework the yaml example though? Or are you using automodule on the utils/ package? I don’t think we have documentation about the creation from yaml otherwise

@oz123
Copy link
Contributor Author

oz123 commented Aug 9, 2019

@micw523 can you be more specific please with your comment? I don't want to address all examples at once.
I just want to commit these two updated examples.
A follow up PR will add an example for kubernetes.util.create_from_yaml

@micw523
Copy link
Contributor

micw523 commented Aug 9, 2019

I just saw that you took off the yaml example. However Sphinx allows us to create automated documentation of the utils/ folder and package with automodule/autoclass. I was wondering if that was your intention after removing the yaml example.

@oz123
Copy link
Contributor Author

oz123 commented Aug 9, 2019

@micw523 that was not my intention. This pull request is only about updating the examples. I also included them in the sphinx docs.
Long term speaking, I would like to add more documentation inside the modules,
and there is also this issue swagger-api/swagger-codegen#9630.
Is there something specific you want me to include in this PR?

@micw523
Copy link
Contributor

micw523 commented Aug 9, 2019

This sounds good to me. @roycaihw what do you think?

@yliaog
Copy link
Contributor

yliaog commented Aug 13, 2019

/assign @micw523
/assign @roycaihw

@micw523
Copy link
Contributor

micw523 commented Aug 13, 2019

/lgtm
Seems like I cannot call tide by using the robot?

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 13, 2019
@roycaihw roycaihw added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Aug 13, 2019
@roycaihw
Copy link
Member

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: oz123, roycaihw

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 13, 2019
@k8s-ci-robot k8s-ci-robot merged commit 2e3b50e into kubernetes-client:master Aug 13, 2019
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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants