Skip to content

Conversation

mihaigalos
Copy link
Contributor

@mihaigalos mihaigalos commented Jul 8, 2025

Enum values in kcl contain pipe symbols (|). These get output to generated docs. In markdown, these break cell alignment and cause the referenced issue this PR is trying to mitigate.

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):

3. Provide a description of the PR(e.g. more details, effects, motivations or doc link):

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

4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):

  • N
  • Y

5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links:

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

@mihaigalos mihaigalos force-pushed the fix/docgen/markdown/pipes-in-enums branch from 266de4b to 9b433b9 Compare July 8, 2025 16:42
@mihaigalos mihaigalos force-pushed the fix/docgen/markdown/pipes-in-enums branch 3 times, most recently from ce1ed08 to 72343b0 Compare July 8, 2025 21:04
This then guarantees the generated markdown cells align properly.

Signed-off-by: Mihai Galos <[email protected]>
@mihaigalos mihaigalos force-pushed the fix/docgen/markdown/pipes-in-enums branch from 72343b0 to f04b848 Compare July 8, 2025 21:07
@Peefy
Copy link
Contributor

Peefy commented Jul 10, 2025

Thank you! Good Job!

Copy link
Contributor

@Peefy Peefy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@coveralls
Copy link

coveralls commented Jul 10, 2025

Pull Request Test Coverage Report for Build 16154397863

Details

  • 35 of 39 (89.74%) changed or added relevant lines in 2 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.1%) to 36.666%

Changes Missing Coverage Covered Lines Changed/Added Lines %
pkg/tools/gen/escape.go 30 34 88.24%
Totals Coverage Status
Change from base Build 15817333373: 0.1%
Covered Lines: 5531
Relevant Lines: 15085

💛 - Coveralls

@mihaigalos
Copy link
Contributor Author

mihaigalos commented Jul 10, 2025

@Peefy this PR is approved and all checks passed. Do I need to do anything else before you merge it?

@mihaigalos
Copy link
Contributor Author

Also, how does this now end up in the kcl binary, will there be an CD pipeline of sorts kicking in?

@Peefy Peefy merged commit 1176e58 into kcl-lang:main Jul 11, 2025
18 checks passed
@mihaigalos mihaigalos deleted the fix/docgen/markdown/pipes-in-enums branch July 11, 2025 12:31
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.

support Go API for GetSchemaTypeMapping
3 participants