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

Fix code docs #85

Merged
merged 2 commits into from
Mar 7, 2023
Merged

Fix code docs #85

merged 2 commits into from
Mar 7, 2023

Conversation

cpuguy83
Copy link
Member

@cpuguy83 cpuguy83 commented Mar 7, 2023

  1. Docs were using godoc style docs rather than rustdoc, so were not being picked up by rustdoc
  2. Added some missing docs
  3. Gave containerd-shim-wasm crate its own README.md so it makes more sense on crates.io

Example rustdoc:

image

cpuguy83 added 2 commits March 7, 2023 21:02
@cpuguy83
Fix/add docs so they show up properly in rustdoc.
07e148a 
Signed-off-by: Brian Goff <[email protected]>
@cpuguy83
Generate README for containerd-shim-wasm
f8b8470 
This allows us to share docs for crates.io as well as docs.rs and have
both look nice.
Also adds validation that any changes are generated and committed to the
repo.
@cpuguy83 cpuguy83 requested a review from Mossaka March 7, 2023 21:19
devigned
devigned approved these changes Mar 7, 2023
View reviewed changes
Copy link
Contributor

@devigned devigned left a comment

Choose a reason for hiding this comment

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

lgtm!

@cpuguy83 cpuguy83 merged commit 2f75c29 into containerd:main Mar 7, 2023
@cpuguy83 cpuguy83 deleted the docs branch March 7, 2023 22:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rumpl rumpl rumpl approved these changes

@devigned devigned devigned approved these changes

@Mossaka Mossaka Awaiting requested review from Mossaka

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@cpuguy83 @rumpl @devigned