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

feat: doc gen: support generate package doc in a single page; add ref link #173

Merged
merged 2 commits into from
Oct 27, 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".):

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

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

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

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

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

feat: doc gen:

  • support generate package doc in a single page;
  • add ref link between schemas
  • 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

Signed-off-by: xiarui.xr <xiarui.xr@antgroup.com>
Signed-off-by: xiarui.xr <xiarui.xr@antgroup.com>
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

Pull Request Test Coverage Report for Build 6663959659

  • 30 of 43 (69.77%) changed or added relevant lines in 2 files are covered.
  • 3 unchanged lines in 1 file lost coverage.
  • Overall coverage decreased (-0.3%) to 65.631%

Changes Missing Coverage Covered Lines Changed/Added Lines %
pkg/tools/gen/genopenapi.go 14 16 87.5%
pkg/tools/gen/gendoc.go 16 27 59.26%
Files with Coverage Reduction New Missed Lines %
pkg/tools/gen/genopenapi.go 3 89.84%
Totals Coverage Status
Change from base Build 6662552616: -0.3%
Covered Lines: 2620
Relevant Lines: 3992

💛 - Coveralls

@Peefy Peefy merged commit cbfc2a6 into kcl-lang:main Oct 27, 2023
6 of 7 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Oct 27, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

support Go API for GetSchemaTypeMapping
3 participants