Skip to content
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

enhance: doc gen tool support escape html option #144

Merged
merged 1 commit into from
Aug 28, 2023

Conversation

amyXia1994
Copy link
Contributor

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

  • N
  • Y

related to #139

2. What is the scope of this PR (e.g. component or file name):

cmds/kcl-go/command/cmd_doc.go
pkg/tools/gen/gendoc.go

pkg/tools/gen/gendoc_test.go

pkg/tools/gen/templates/doc/packageDoc.gotmpl
pkg/tools/gen/templates/doc/schemaDoc.gotmpl

pkg/tools/gen/testdata/doc/

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

enhance: doc gen tool support escape html option

  • 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

@coveralls
Copy link

Pull Request Test Coverage Report for Build 6000232301

  • 16 of 18 (88.89%) changed or added relevant lines in 1 file are covered.
  • 3 unchanged lines in 1 file lost coverage.
  • Overall coverage increased (+0.08%) to 64.139%

Changes Missing Coverage Covered Lines Changed/Added Lines %
pkg/tools/gen/gendoc.go 16 18 88.89%
Files with Coverage Reduction New Missed Lines %
pkg/tools/gen/gendoc.go 3 67.5%
Totals Coverage Status
Change from base Build 5975056464: 0.08%
Covered Lines: 2470
Relevant Lines: 3851

💛 - Coveralls

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

@Peefy Peefy merged commit db26759 into kcl-lang:main Aug 28, 2023
6 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Aug 28, 2023
@amyXia1994 amyXia1994 deleted the enhance/doc-html-escape branch August 30, 2023 09:44
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

support Go API for GetSchemaTypeMapping
3 participants