Skip to content

Clean-up for wording, typos, grammar, etc. #516

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Jun 7, 2025

Conversation

eliasp
Copy link
Contributor

@eliasp eliasp commented Jun 6, 2025

1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):

  • N
  • Y

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

  • Affects user behaviors
  • Contains syntax changes
  • Contains variable changes
  • Contains experimental features
  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Other

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?

  • N
  • Y

5. Are there test cases for these changes?

  • Unit test
  • Integration test
  • Benchmark (add benchmark stats below)
  • Manual test (add detailed scripts or steps below)
  • Other

Copy link

vercel bot commented Jun 6, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
kcl-lang-io ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 6, 2025 4:18pm

eliasp added 13 commits June 6, 2025 17:30
The code generating this output adds an underscore between first name
and last name.

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]>
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]>
@Peefy
Copy link
Contributor

Peefy commented Jun 7, 2025

Thank you! LGTM

@Peefy Peefy merged commit e3d692d into kcl-lang:main Jun 7, 2025
7 of 8 checks passed
@eliasp eliasp deleted the typos-and-wording branch June 9, 2025 00:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants