bitovi / bitovi/documentjs

Type links

Open
#58 0 comments 0 reactions 0 assignees View on GitHub
feature
Dominant language
JavaScript
Stars
598
Forks
371
PR merge metrics
No merged PRs in 30d

Description

It would be nice to be able to link to a type that is documented elsewhere on the web. For example you might have a function like:

```
@function xhr
@param {Object} options
@return {Promise} a promise that will resolve when the xhr is complete.
```

In which case you would want Promise to link to the MDN documentation. Perhaps "@typelink" could do this:

```
@typelink Promise https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.