Documentation: Uniform style#1016
Conversation
zhassan-aws
left a comment
There was a problem hiding this comment.
The changes to make notes and links to code consistent look good to me. I'm not sure about the contractions though. In fact, I'm a bit opposed to getting rid of them, as they make the document a bit too formal. The Rust book as well as standard library documentation uses contractions, so I think we should keep them.
8cb049d to
1a4c784
Compare
|
That's fair, I did not realize contractions were being used there. The changes are now split into several commits. The last ones add more contractions, except in cases were "not" was being contracted (these look a little forced sometimes). We can drop them if you want to keep the text as is. |
zhassan-aws
left a comment
There was a problem hiding this comment.
I'm OK with the extra contractions, except for the two that I pointed out.
0b6c894 to
a583cb0
Compare
* Remove "The" in documentation title * Use `**NOTE**:` for all notes * Use "code available here" for links to example files. * Use `<directory>` as labels for links to directories * Use more contractions
* Remove "The" in documentation title * Use `**NOTE**:` for all notes * Use "code available here" for links to example files. * Use `<directory>` as labels for links to directories * Use more contractions
Description of changes:
Makes a series of changes so that the documentation shows a uniform style:
**NOTE**:for all notes/warnings.<directory>as labels for links to directories.SUMMARY.md- now "Kani Rust Verifier"Resolved issues:
Resolves #700
Call-outs:
Testing:
How is this change tested? N/A
Is this a refactor change? No
Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.