Documentation: Uniform style #1016
Merged
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
zhassan-aws
reviewed
Apr 6, 2022
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.
adpaco-aws
force-pushed
the
doc-review-uniform
branch
from
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
approved these changes
Apr 6, 2022
adpaco-aws
force-pushed
the
doc-review-uniform
branch
from
0b6c894 to
a583cb0
Compare
tedinski
pushed a commit
to tedinski/rmc
that referenced
this pull request
Apr 22, 2022
* 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
tedinski
pushed a commit
to tedinski/rmc
that referenced
this pull request
Apr 25, 2022
* 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
tedinski
pushed a commit
to tedinski/rmc
that referenced
this pull request
Apr 26, 2022
* 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
tedinski
pushed a commit
that referenced
this pull request
Apr 27, 2022
* 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
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.
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.