Improved ref docs for model #2951
Conversation
timotheeguerin
requested review from
bterlson,
daviwil,
markcowl and
allenjzhang
as code owners
|
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.
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 |
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