-
Notifications
You must be signed in to change notification settings - Fork 110
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
doc generate error / 文档生成错误 #1424
Comments
Hello @LinYunling The type of attribute schema ResourceModel:
'''
Resource Model Definition
Attributes
----------
name: str, default is "", required.
The name of resource.
alias: str, default is "", optional.
The alias name of resource.
type: str, default is "string", required.
The type of resource.
Examples
----------------------
res = ResourceModel {
name = "ServerA"
alias = "My Computer"
type = "PC"
}
'''
name: str
alias?: str # Note the `?` here.
type: str
check:
type in ["PC", "Notebook", "IPad", "SmartPhone"] |
Only the description is from comments ? |
The document is misleading. |
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Bug Report
Please answer these questions before submitting your issue. Thanks!
1. Minimal reproduce step (Required)
The schema define:
schema ResourceModel:
'''
Resource Model Definition
'''
name: str
alias: str
type: str
check:
type in ["PC", "Notebook", "IPad", "SmartPhone"]
kcl doc generate
see the markdown file, the result is error.
![image](https://private-user-images.githubusercontent.com/14899416/341349849-c71e9918-942f-4382-86f4-fa402b615522.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjA1NzM2NDgsIm5iZiI6MTcyMDU3MzM0OCwicGF0aCI6Ii8xNDg5OTQxNi8zNDEzNDk4NDktYzcxZTk5MTgtOTQyZi00MzgyLTg2ZjQtZmE0MDJiNjE1NTIyLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MTAlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzEwVDAxMDIyOFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTI1ODEzMzAzNWEzNjkyYmQ2NWI4NjY0M2Y5MzkxOGIwYTAyYTBhNDAzZjBiODM0ZTcyMDVkNTlkYmExOGY5YWImWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.AqanYbT0d1pyjP3os046pTOHtqxInmbw5f0tqW3GfAM)
2. What did you expect to see? (Required)
3. What did you see instead (Required)
like 2
4. What is your KCL components version? (Required)
0.9.0-beta.1
![image](https://private-user-images.githubusercontent.com/14899416/341346933-13596a07-35e5-434e-bf03-18a4b0d22293.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjA1NzM2NDgsIm5iZiI6MTcyMDU3MzM0OCwicGF0aCI6Ii8xNDg5OTQxNi8zNDEzNDY5MzMtMTM1OTZhMDctMzVlNS00MzRlLWJmMDMtMThhNGIwZDIyMjkzLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MTAlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzEwVDAxMDIyOFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTk1YjY2YTc4NzFlMmQxYWY3NDY5OWY4ODBhMjc0NDcxYmVmMWQ2M2EyODg3NWEyMDcwM2JlODQ4MjQ4OGEzZDImWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.8WZRMQa70EL5k7oImgKKnpDDSa485kJg7AL8n_uxu5w)
The text was updated successfully, but these errors were encountered: