Clean-up for wording, typos, grammar, etc. #516
Merged
Conversation
This file contains hidden or 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
The code generating this output adds an underscore between first name and last name. Signed-off-by: Elias Probst <[email protected]>
Signed-off-by: Elias Probst <[email protected]>
…nate`) Signed-off-by: Elias Probst <[email protected]>
Signed-off-by: Elias Probst <[email protected]>
- use a Markdown quote block, which has already been used in some places - get rid of `..note::` artifacts that looked, like the docs were initially written in rst Signed-off-by: Elias Probst <[email protected]>
Signed-off-by: Elias Probst <[email protected]>
Signed-off-by: Elias Probst <[email protected]>
Signed-off-by: Elias Probst <[email protected]>
Signed-off-by: Elias Probst <[email protected]>
Signed-off-by: Elias Probst <[email protected]>
Even though in some cases the syntax-highlighting (e.g. for comments) might look good enough, in other cases it produces completely inconsistent results (e.g. keywords) and is also semantically wrong. As long as there is no syntax-highlighting support for KCL, just use plain-text. Signed-off-by: Elias Probst <[email protected]>
Signed-off-by: Elias Probst <[email protected]>
…yword Signed-off-by: Elias Probst <[email protected]>
Contributor
|
Thank you! LGTM |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):
2. What is the scope of this PR (e.g. component or file name):
kcl-lang.io/docs
3. Provide a description of the PR
This PR addresses minor issues in the docs regarding typos, wording, grammar, cosmetics etc.
For the details, see the individual commits.
4. Are there any breaking changes?
5. Are there test cases for these changes?