Minor updates in README for readability.#1018
Conversation
README.md
Outdated
| * Memory Safety -- even in unsafe rust code. | ||
| * User specified assertions. | ||
| * Absence of panics. | ||
| * Checks for some classes of undefined behavior. |
There was a problem hiding this comment.
In case it's helpful, the rule I followed to write this is the second case in https://www.dailywritingtips.com/bulleted-lists/
I'm okay with first letters being capitalized, but I don't think we should keep the dots. Also, Rust is a name.
There was a problem hiding this comment.
Thanks for the link, I'll use it here on. I think keeping the first letters capitalized makes it easier to read. I'll remove the dots add Rust as a name.
README.md
Outdated
|
|
||
| #[kani::proof] | ||
| fn check_my_property() { | ||
|
|
There was a problem hiding this comment.
I agree lines between these help, but I would remove this first one (most of the time, programs have a comment or declaration here).
…into update-readme-visual
README.md
Outdated
| * Memory Safety -- even in unsafe Rust code | ||
| * User specified assertions | ||
| * Absence of panics | ||
| * Checks for some classes of undefined behavior |
There was a problem hiding this comment.
We should also change this to "Absence of some classes of undefined behavior", since the sentence is "Kani verifies ..." which does not fit with "Check for some classes ...".
There was a problem hiding this comment.
@tedinski @adpaco-aws thoughts?
I personally agree with the suggestion.
There was a problem hiding this comment.
Actually, the way I understood this sentence is that Kani verifies the checks for those classes (here "checks" could be a noun or verb). But it may be better to rephrase just in case.
There was a problem hiding this comment.
Yeah, that could be a bit confusing to first time readers
adpaco-aws
left a comment
There was a problem hiding this comment.
Thanks! Just a minor correction.
README.md
Outdated
| * absence of panics | ||
| * checks for some classes of undefined behavior | ||
| * Memory Safety -- even in unsafe Rust code | ||
| * User specified assertions |
There was a problem hiding this comment.
| * User specified assertions | |
| * User-specified assertions |
* Update readme for readability
* Update readme for readability
Description of changes:
The current README has some text and code that's difficult to read. This change adds some spacing and some capitalizing.
Before -
After -
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.