Skip to content

Conversation

amyXia1994
Copy link
Contributor

@amyXia1994 amyXia1994 commented Aug 17, 2023

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

  • N
  • Y

feat: support generate package index page

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

pkg/tools/gen/gendoc.go
pkg/tools/gen/genopenapi.go
pkg/tools/gen/types.go

pkg/tools/gen/gendoc_test.go
pkg/tools/gen/testdata/doc/...

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

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

  • support generate package index page
  • support number multiplier
  • fix kclType and schemaId evaluation
  • add more tests
  • 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
  • pkg/tools/gen/gendoc_test.go

@amyXia1994 amyXia1994 requested a review from Peefy August 17, 2023 13:25
@coveralls
Copy link

coveralls commented Aug 17, 2023

Pull Request Test Coverage Report for Build 5891581314

  • 84 of 96 (87.5%) changed or added relevant lines in 3 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage increased (+0.5%) to 63.034%

Changes Missing Coverage Covered Lines Changed/Added Lines %
pkg/tools/gen/gendoc.go 41 53 77.36%
Files with Coverage Reduction New Missed Lines %
pkg/tools/gen/genopenapi.go 1 94.55%
Totals Coverage Status
Change from base Build 5875171191: 0.5%
Covered Lines: 2348
Relevant Lines: 3725

💛 - 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 added the tool label Aug 17, 2023
@Peefy Peefy merged commit dc6f590 into kcl-lang:main Aug 17, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Aug 17, 2023
@amyXia1994 amyXia1994 deleted the feat/doc-packageDoc branch August 18, 2023 03:40
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