search

microsoft / typespec

https://typespec.io/
MIT License
4.13k stars 199 forks source link

Enhance @doc to support a filepath argument #1608

Open asilverman opened 1 year ago

asilverman commented 1 year ago

If @doc could support a filepath argument from which to fetch the contents, the cadl file would be easier to read. This is especially important if there is a lot of content to append. Especially helpful if the content contains image references and tables, etc...

markcowl commented 1 year ago

Note that readability is enhanced by using augment decoratros for long doc content (@@doc can go in a different file and reference the targeted element)

asilverman commented 1 year ago

@markcowl I am not sure I understand the comment, can you elaborate?