docs: add examples and documentation in the guide about HOCAP style logatom - #2619
docs: add examples and documentation in the guide about HOCAP style logatom#2619bsdinis wants to merge 2 commits into
Conversation
|
I think Travis might have mentioned this at the retreat, but maybe making this a module-level rustdoc for |
|
We should definitely have verusdoc style docs for logatom in vstd, but we also desperately need more "guide" material on the subject of concurrency verification, which should include an overview of logical atomicity approaches, among other topics. So I think this material, as written, is appropriate for the guide. It's probably fine as-is; we can organize it more later once we have more material. |
be14319 to
67f39c7
Compare
parno
left a comment
There was a problem hiding this comment.
Thanks for working on this! I realize it's still work in progress, but I was curious to take a look.
|
|
||
| ## Calling `apply` | ||
|
|
||
| Consider the example of a monotonic counter (as seen in the examples dir). |
There was a problem hiding this comment.
Ideally, the Guide examples should be readable in the guide, without having to refer to the Verus files elsewhere in the repo. Can you use some anchor tags to include relevant snippets from the file here instead?
There was a problem hiding this comment.
If the example is too large, we could also hide it behind an HTML <detail> element so it doesn't interrupt the flow of the explanation too much. The mdbook does seem to support this, but it would be the first time we do this in the guide.
There was a problem hiding this comment.
I think the point here is to guide through the HOCAP parts of the example, and the reference to the guide is just for reference (pardon my tautology).
If we do want to insist on having the full thing, the way to go is the <detail>, but at the end of the example
8d5814e to
faaaed6
Compare
By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.