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.

Sign up for GitHub

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

Jump to bottom

Documentation cleanup around Api core_methods and dynamic_watcher #1158

Merged
merged 3 commits into from
Mar 5, 2023
Merged

Documentation cleanup around Api core_methods and dynamic_watcher #1158

merged 3 commits into from
Mar 5, 2023

Conversation

clux
Copy link
Member

@clux clux commented Mar 3, 2023 •
edited
Loading

  • dynamic_watcher example now uses Pod by default so it's by default runnable everywhere
  • adds doc examples to PartialObjectMetaExt
  • Api core_methods.rs docs revamp:
    • async_wrapper everywhere rather than a full #[tokio::main] - partially doing Simplify async doc examples #912 (but avoiding subresources because Jessie is working on subresources)
    • slight rewording in places (not examples, examples left in place)
    • Api::patch_metadata example now uses PartialObjectMetaExt to create a more type-safe patch
  • fixes a few copy-paste errors between Api::watch_metadata and metadata_watcher (now cross-reference)

clux added 2 commits March 3, 2023 06:31
@clux
Minor fixes to metadata watcher examples
8d4e302 
- makes dyn watcher runnable without clux.dev crds

Signed-off-by: clux <sszynrae@gmail.com>
@clux
Fixup core_methods Api docs to use async_wrapper
b0882c9 
Also add better examples to metadata api and using new conversion.

Signed-off-by: clux <sszynrae@gmail.com>
@clux clux added the changelog-fix changelog fix category for prs label Mar 3, 2023
@clux clux added this to the 0.81.0 milestone Mar 3, 2023
@clux clux changed the title Documentation cleanup around Api core_methods and dynamic_watcher Documentation cleanup around Api core_methods and dynamic_watcher Mar 3, 2023
@clux clux mentioned this pull request Mar 3, 2023
Merged
@clux
ping hooks - 2023-03-03
31e7e57 
Signed-off-by: clux <sszynrae@gmail.com>
@clux clux added docs unclear documentation changelog-exclude changelog excluded prs and removed changelog-fix changelog fix category for prs labels Mar 4, 2023
@clux
Copy link
Member Author

clux commented Mar 5, 2023

Merging as it's just small docs improvement and they should be uncontroversial.

@clux clux merged commit 80d43fd into main Mar 5, 2023
@clux clux deleted the fix-ex branch March 5, 2023 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
changelog-exclude changelog excluded prs docs unclear documentation
Projects
None yet
Milestone
0.81.0
Development

Successfully merging this pull request may close these issues.
1 participant
@clux