feat: doc gen html escape for default value - Githubissues

kcl-lang / kcl-go

KCL Go SDK

https://pkg.go.dev/kcl-lang.io/kcl-go@main

Apache License 2.0

52 stars 26 forks source link

feat: doc gen html escape for default value #218

Closed Peefy closed 9 months ago

Peefy commented 10 months ago

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

[x] N
[ ] Y
feat: doc gen html escape for default value

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

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

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

[ ] Affects user behaviors
[ ] Contains syntax changes
[ ] Contains variable changes
[ ] Contains experimental features
[ ] Performance regression: Consumes more CPU
[ ] Performance regression: Consumes more Memory
[x] Other

4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):

[x] N
[ ] Y

5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links:

[x] Unit test
[ ] Integration test
[ ] Benchmark (add benchmark stats below)
[ ] Manual test (add detailed scripts or steps below)
[ ] Other
pkg/tools/gen/testdata/doc/pkg/server.k
pkg/tools/gen/testdata/doc/pkg/md/main.md