Move documentation of kani_core modules to right places #3851
+51
−52
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
carolynzech
requested changes
Jan 24, 2025
There was a problem hiding this comment.
Instead of deleting the documentation from each of the files, can you keep a sentence or two about what they do, and then refer to the new location of the docs for full details? I agree that our full docs should be visible to our users, but for internal development, it's still useful to have some comments at the top of the file explaining what it does. For example, in kani_core::mem, can you add a sentence back like "This module contains functions useful for checking unsafe memory accesses. For full documentation, see lib.rs"?
(Also, were you able to test this at all to demonstrate that these moves fix the problem?)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #3815
Documentations of
kani_coremodules doesn't show up correctly on https://model-checking.github.io/kani/crates/doc/kani/mem/index.html. This PR move the comments to the right place so that they will show up correctly.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.