enhance: doc parser support schema example #703
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Close #668
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):
kclvm/api/src/service/ty.rs
kclvm/sema/src/resolver/doc.rs
kclvm/sema/src/resolver/global.rs
kclvm/sema/src/resolver/mod.rs
kclvm/sema/src/ty/mod.rs
kclvm/spec/gpyrpc/gpyrpc.proto
kclvm/api/src/testdata/get-schema-type-mapping.json
kclvm/api/src/testdata/get-schema-type-mapping.response.json
kclvm/sema/src/resolver/test_data/doc.k
3. Provide a description of the PR(e.g. more details, effects, motivations or doc link):
This PR support parsing the
Examples
section from the schema docstring, and exposes the examples field from theKclvmService.GetSchemaTypeMapping
APINote: The
Example.value
field of theKclvmService.GetSchemaTypeMapping
API changed to string type.4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):
5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links: