microsoft / typespec

https://typespec.io/
MIT License
3.88k stars 174 forks source link

Documentation missing for built-in decorators #1550

Closed mikekistler closed 1 year ago

mikekistler commented 1 year ago

I discovered a neat trick for checking for missing decorator docs. If you compile any cadl file and specify --trace bind.js.decorator cadl will print diagnostics that show all the bound decorators in known namespaces. Filtering this by the "Cadl" namespace and cross checking with the Built-in decorators page on the website shows that the following decorators are missing from the docs:

bterlson commented 1 year ago

These are all manually documented right now. @allenjzhang is looking into auto-generating stdlib docs (along with compiler API docs which are also missing).

nguerrera commented 1 year ago

I think for decorators, these should be moved to extern dec declarations if only documented in .ts now. That would get picked up by the existing doc infrasructure and the IDE. I believe we planned to filter out the $-prefixed decorator functions from the JS API docs?

markcowl commented 1 year ago

Please find the duplicate issue

markcowl commented 1 year ago

verify: are we generating docs from the core library?

tjprescott commented 1 year ago

@serviceVerson and @serviceTitle have been removed... so that's two down 😄