Skip to content

Fixed cargo doc failing to compile #1331

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.

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

Merged

Conversation

YoshikiTakashima
Copy link
Contributor

@YoshikiTakashima YoshikiTakashima commented Jul 1, 2022

Description of changes:

No change to Kani's behavior. Fixes the issue of cargo doc --workspace refusing to compile. Cargo doc warnings are fixed in commits b415ff2 - d0154c2.

Resolved issues:

Resolves #1282

Call-outs:

  • Cargo doc still gives errors in non-critical areas. Fixed as of d0154c2
  • c283594 fixes a link to a function that no longer exists in
    rustc_middle. Please check that this is an accurate fix, as I have
    no baseline.

Testing:

  • How is this change tested? Run cargo doc --workspace to check that compile issue has been fixed. Manually confirm that doc fixes are reasonable.

  • Is this a refactor change?

Checklist

  • Each commit message has a non-empty body, explaining why the change was made
  • Methods or procedures are documented
  • Regression or unit tests are included, or existing tests cover the modified code
  • My PR is restricted to a single feature or bugfix

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.

@YoshikiTakashima YoshikiTakashima requested a review from a team as a code owner July 1, 2022 22:27
Copy link
Contributor

@celinval celinval left a comment

Choose a reason for hiding this comment

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

It looks good! Thanks for doing this. Can you please add cargo doc to the regression script or at least to the CI? Thanks

Copy link
Contributor

@celinval celinval left a comment

Choose a reason for hiding this comment

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

Thanks!

@YoshikiTakashima
Copy link
Contributor Author

Also fixes minor blocker for #1008

@YoshikiTakashima YoshikiTakashima merged commit 7cd1aeb into model-checking:main Jul 5, 2022
@YoshikiTakashima YoshikiTakashima deleted the yoshi-cargo-doc-fix branch July 5, 2022 18:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cargo doc not building. Errors from kani-compiler
2 participants