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

fix: indent attribute doc #46

Merged
merged 6 commits into from Jun 29, 2023
Merged

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

fix #30

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

pkg/swagger/generator/template_repo.go
pkg/swagger/generator/templates/header.gotmpl
pkg/swagger/generator/templates/introduction.gotmpl

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

fix the indentation in generated attribute doc

  • 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/swagger/generator/template_repo_test.go

6. Release note

Please refer to Release Notes Language Style Guide to write a quality release note.

fix the indentation in generated attribute doc

@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 5402737827

  • 11 of 11 (100.0%) changed or added relevant lines in 1 file are covered.
  • 6 unchanged lines in 1 file lost coverage.
  • Overall coverage decreased (-0.08%) to 66.781%

Files with Coverage Reduction New Missed Lines %
pkg/swagger/generator/template_repo.go 6 63.61%
Totals Coverage Status
Change from base Build 5368888637: -0.08%
Covered Lines: 1950
Relevant Lines: 2920

💛 - 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 404b65f into kcl-lang:main Jun 29, 2023
4 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jun 29, 2023
@amyXia1994 amyXia1994 deleted the fix/indent-attr-doc branch June 29, 2023 12:37
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.

wrong indenting when generate from schema/attribute description to docstring
3 participants