Skip to content

Fix some cargo docs #749

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
Merged
merged 5 commits into from
Aug 5, 2025
Merged

Fix some cargo docs #749

merged 5 commits into from
Aug 5, 2025
+218 −85

Conversation

ludfjig
Copy link
Contributor

@ludfjig ludfjig commented Jul 31, 2025 •
edited
Loading

Closes #731

Fixes some outdated docs, adds some docs where it was missing. Mostly adds docs to snapshotting. Adds CI job to run cargo doc

@ludfjig ludfjig added area/documentation Related to documentation kind/enhancement For PRs adding features, improving functionality, docs, tests, etc. labels Jul 31, 2025
simongdavies
simongdavies previously approved these changes Jul 31, 2025
View reviewed changes
Copy link
Contributor

@simongdavies simongdavies left a comment

Choose a reason for hiding this comment

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

@ludfjig , a couple of nits but this is great Thanks!!

@ludfjig ludfjig force-pushed the fix_doc branch 2 times, most recently from 0dd38c7 to 4f20353 Compare July 31, 2025 16:32
syntactically
syntactically reviewed Jul 31, 2025
View reviewed changes
@ludfjig ludfjig force-pushed the fix_doc branch 2 times, most recently from 7dc5c6d to da622de Compare August 1, 2025 17:46
ludfjig added 5 commits August 4, 2025 11:17
@ludfjig
Fix cargo doc warnings
0ec00f6 
Signed-off-by: Ludvig Liljenberg <[email protected]>
@ludfjig
Update docs for UninitializedSandbox
ea9b33d 
Signed-off-by: Ludvig Liljenberg <[email protected]>
@ludfjig
Update docs for MultiUseSandbox
c89a8c2 
Signed-off-by: Ludvig Liljenberg <[email protected]>
@ludfjig
Add crate-level docs to lib.rs
998680d 
Signed-off-by: Ludvig Liljenberg <[email protected]>
@ludfjig
Test cargo doc on ci
d6d4872 
Signed-off-by: Ludvig Liljenberg <[email protected]>
jprendes
jprendes approved these changes Aug 5, 2025
View reviewed changes
Copy link
Contributor

@jprendes jprendes left a comment

Choose a reason for hiding this comment

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

<3 Thanks @ludfjig !
Much needed attention to the doc :-)

@ludfjig ludfjig merged commit 70a856f into hyperlight-dev:main Aug 5, 2025
33 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jprendes jprendes jprendes approved these changes

@syntactically syntactically syntactically left review comments

@simongdavies simongdavies simongdavies left review comments

@danbugs danbugs Awaiting requested review from danbugs danbugs is a code owner

@dblnz dblnz Awaiting requested review from dblnz dblnz is a code owner

@devigned devigned Awaiting requested review from devigned devigned is a code owner

@marosset marosset Awaiting requested review from marosset marosset is a code owner

Assignees
No one assigned
Labels
area/documentation Related to documentation kind/enhancement For PRs adding features, improving functionality, docs, tests, etc.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Code docs are incorrect after removal of MultiUseGuestCallContext
4 participants
@ludfjig @simongdavies @jprendes @syntactically