-
Notifications
You must be signed in to change notification settings - Fork 222
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
[Member] links don't render #1528
Comments
Yeah, basically this was a way to just call things out as being 'code related'. Happy to actually switch everything to an appropriate hyperlinking form once someone can tell me what that form should be that is reasonable stable :) |
We should investigate whether using JSDoc |
There's no rhyme or reason on |
Yep, I'll take a look and report back. |
Editor support for |
We seem to use
[Type]
and[Method(func)]
annotations in some of our API documentation, presumably hoping that these will get rendered as hyperlinks. For example, see Output:I assume the
[Output.apply(func)]
,[Resource]
,[.apply]
, and various[Output]
s, are intended to be hyperlinked to the relevant members?This pattern is prevalent in the Pulumi SDK itself in addition to addition to packages like AWSX (Crosswalk). I believe @CyrusNajmabadi has written most of them, so we should ask whether this is a convention that should be being respected, or maybe the API docs themselves are simply wrong and should use a different syntax.
The text was updated successfully, but these errors were encountered: