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

add auto-generated warning in generated docs; update unit test #140

Merged
merged 3 commits into from
Aug 21, 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):

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

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

add auto-generated warning in generated docs; update unit test

  • 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 5923793244

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 63.043%

Totals Coverage Status
Change from base Build 5899293009: 0.0%
Covered Lines: 2349
Relevant Lines: 3726

💛 - Coveralls

@Peefy Peefy added the tool label Aug 21, 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 8fb20d7 into kcl-lang:main Aug 21, 2023
6 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Aug 21, 2023
@amyXia1994 amyXia1994 deleted the feat/doc-gen branch August 21, 2023 10:20
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