chore(jsdoc): fix some JSDoc @link
tags
#5448
Draft
+25
−23
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This fixes some
@link
tags in JSDoc which weren't resolving correctly. Since the Typedoc tool reports on@link
tags which it can't resolve we can use that to find them.What is the current behavior?
Some of these links don't actually resolve! It's a bit hard to see this, but one way that I can test if the
{@link Foo}
is correctly resolving the symbolFoo
is to ask the LSP about it in my editor. If the name can be resolved then I'll see some info about it, otherwise I won't. This shows the before and after of this insrc/cli/run.ts
:Screen.Recording.2024-03-08.at.2.24.04.PM.mov
We have
import type * as d from '../declarations';
at the top of the file, sod.CompilerSystem
can be resolved butCompilerSystem
cannot.What is the new behavior?
Several of these are fixed! A few where it would be required to add a new import to a module in order to get something to resolve I just turned into comments instead.
Does this introduce a breaking change?
Testing
Try to make sure that these actually resolve, possibly using the method outlined above with the LSP in an editor. Or just try to reason about it.