RFC: Add new @link syntax to leverage beta declaration reference format
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5k
- Forks
- 162
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 8
Description
The current TSDoc declaration reference syntax differs from the new proposed declaration reference syntax. I would propose the following additional syntax for {@link} and related tags as a means opt-in to the new proposed declaration reference syntax:
`{` `@link` `{` beta-declaration-reference `}` `}`
`{` `@link` `{` beta-declaration-reference `}` `|` link-title `}`
For example:
/**
* Normal:
* {@link package#MyClass}
* {@link package#(Merged:interface)}
* {@link (Merged:interface)}
*
* Beta:
* {@link {package!MyClass}}
* {@link {package!Merged:interface}}
* {@link {Merged:interface}}
*/
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the proposed beta declaration-reference syntax and the existing TSDoc specification for {@link} and related tags. Compare the normal and beta examples in this issue, then determine the required specification and parser scope. Done means the syntax decision is resolved and its behavior is documented and covered by the project's relevant tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100