Make sure augmented doclets are pointing to the correct source file
Open
Nobody has claimed this yet.
bugfix
- Dominant language
- JavaScript
- Stars
- 15.5k
- Forks
- 1.5k
- Avg merge
- 10d 23h
- Merged PRs (30d)
- 1
Description
On the mailing list, a user reported that when he used the @inheritdoc tag, the source-file links in the resulting docs pointed to the thing that was being inherited, rather than the source file that actually contained the @inheritdoc tag.
We should check all of the following tags and fix this issue if necessary:
@augment@inheritdoc@mixes@override
Contributor guide
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 reproducing the source-file links generated for @augment, @inheritdoc, @mixes, and @override, then trace the link-generation path in the JavaScript documentation pipeline. Done means each tag points to the file containing the relevant tag or declaration, with regression coverage for the affected cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100