Improve README.md with better example and descriptions. #250
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: brendandburns 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 |
k8s-ci-robot
added
approved
| ## Generating code | ||
| ### Listing Objects | ||
| ```c# | ||
| var namespaces = client.ListNamespace(); |
There was a problem hiding this comment.
Nitpick: We should prefer showing the async methods to the blocking ones. It is easy to translate in either direction of course, but we should set the expectation that async is the 'normal' way to do it.
There was a problem hiding this comment.
the examples are all sync right now. Let's do this in a separate PR.
README.md
Outdated
| var result = client.CreateNamespace(ns); | ||
| Console.WriteLine(result); | ||
|
|
||
| var result = client.CreateNamespace(ns); |
There was a problem hiding this comment.
Not clear why you're doing this twice. Is it a copypasta, or are you intending to show the behaviour if a user creates an already-created resource? If the latter then suggest commenting it to explain the expected output.
There was a problem hiding this comment.
Actually I think it must be a copypasta because redeclaring result won't compile will it?
There was a problem hiding this comment.
yep, copy/paste
README.md
Outdated
| ``` | ||
|
|
||
| # Usage | ||
| ### Deleting Objects |
There was a problem hiding this comment.
Covered under Creating and Deleting Objects or did you mean to move the delete code from there to under here?
README.md
Outdated
| ``` | ||
|
|
||
| # Usage | ||
| ### Deleting Objects | ||
| ```c# |
There was a problem hiding this comment.
Possible unclosed Markdown tag?
|
@itowlson friendly ping on this one :) |
|
@itowlson pingity ping ping :) Thanks! |
brendandburns
added
the
lgtm
Fixes #249