Skip to content

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

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/k8s/...
pkg/tools/gen/testdata/doc/pkg/...
pkg/tools/gen/testdata/doc/reimport/...

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

enhance doc gen tool: update package index page

  • 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

@amyXia1994 amyXia1994 force-pushed the enhance/package-index-page branch 2 times, most recently from 893eb43 to 0f8d465 Compare August 25, 2023 08:07
@coveralls
Copy link

Pull Request Test Coverage Report for Build 5973478730

  • 86 of 90 (95.56%) changed or added relevant lines in 1 file are covered.
  • 12 unchanged lines in 2 files lost coverage.
  • Overall coverage increased (+0.2%) to 64.008%

Changes Missing Coverage Covered Lines Changed/Added Lines %
pkg/tools/gen/gendoc.go 86 90 95.56%
Files with Coverage Reduction New Missed Lines %
pkg/tools/gen/genopenapi.go 3 93.07%
pkg/tools/gen/gendoc.go 9 65.49%
Totals Coverage Status
Change from base Build 5949227181: 0.2%
Covered Lines: 2456
Relevant Lines: 3837

💛 - Coveralls

@amyXia1994 amyXia1994 force-pushed the enhance/package-index-page branch from 0f8d465 to 49a95b5 Compare August 25, 2023 08:57
@Peefy Peefy added documentation Improvements or additions to documentation tool labels Aug 25, 2023
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 092f003 into kcl-lang:main Aug 25, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Aug 25, 2023
@amyXia1994 amyXia1994 deleted the enhance/package-index-page branch August 25, 2023 11:07
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation tool
Projects
None yet
Development

Successfully merging this pull request may close these issues.

support Go API for GetSchemaTypeMapping
3 participants