Simplify async doc examples #912
Labels
docs
unclear documentation
good first issue
Good for newcomers
help wanted
Not immediately prioritised, please help!
There are two patterns we use in our docs at the moment:
e.g. kube-client/src/api/core_methods.rs
e.g. kube-runtime/src/events.rs
The first leads to the full async-setup visible in every example (via e.g. Api docs), and the second leads to business-action only (e.g. via EventRecorder docs)
We should align api docs so that we use the second pattern where possible. Comment out hidden imports, comment out the async wrappers. Deindent.
If we are documenting in
kube_runtime
we can also use more of the/// # let client: kube::Client = todo!();
pattern to focus on what the crate is about, not whatkube_client
is about.To find places to replace search within the crates:
affected crates:
(the ones in examples/e2e/readmes should be left in place)
The text was updated successfully, but these errors were encountered: