Pete Gonzalez

Results 561 comments of Pete Gonzalez

> Would this potentially enable inserting Markdown snippets from another file? I assume you could use this as a general text insertion mechanism but wasn't sure if the content would...

Right, TSDoc is designed for generating the "**API Reference**" section of your documentation. This is the section that shows all the classes/enums/etc in a big index. The API Reference is...

@GuillaumedesPommareSAP I think it would be reasonable for TSDoc to allow a `.` in the parameter name, like this: ```ts /** * @param message - a message * @param mOptions...

(BTW this came up earlier in https://github.com/microsoft/tsdoc/issues/63#issuecomment-422601919. In that discussion, I was proposing that `@throws` should not be interpreted as an exhaustive list of all possible errors. Instead, it should...

Whenever TSDoc refers to a type, it needs to be a rigorous syntax that is able to express any possible API type. JSDoc uses something called [name paths](https://jsdoc.app/about-namepaths.html) for this....

Heh, I suppose a super simple option is like this: ```ts /** * @throws {@link @microsoft/core-library#MyError} a description of when it happens */ export function doSomething(): void; ```

Are you proposing an informal convention that would be proprietary to your tool? In other words, TSDoc should treat `@throws` as a generic rich text block, but specific implementations can...

I created [PR 175](https://github.com/microsoft/tsdoc/pull/175) to add support for this tag.

The RFCs will all get closed when we post the first draft of the spec document.