-
Notifications
You must be signed in to change notification settings - Fork 226
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
Improved ref docs for model #2951
Improved ref docs for model #2951
Conversation
All changed packages have been documented. |
You can try these changes at https://cadlplayground.z22.web.core.windows.net/prs/2951/ Check the website changes at https://tspwebsitepr.z22.web.core.windows.net/prs/2951/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks fantastic! Thank you @timotheeguerin for working on this. Most of my comments are "food for thought" only, though before merging I think it would be good to decide what we should display when a model has no properties. To me, if I saw an empty table I would assume it's a bug.
that's fair, I don't have a strong opinion on this I can change |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One unfortunate change in anonymous model representation, otherwise, lgtm
fix Azure/typespec-azure-pr#3861 fix microsoft#2232 Generate docs for model properties and reference models within the same package <img width="1213" alt="image" src="https://github.com/microsoft/typespec/assets/1031227/ae7eccd0-97d8-401e-b07f-3375c7b41446">
fix https://github.com/Azure/typespec-azure-pr/issues/3861
fix #2232
Generate docs for model properties and reference models within the same package