-
Notifications
You must be signed in to change notification settings - Fork 24.8k
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
docs: invalid HammerLoader link reference #55836
base: main
Are you sure you want to change the base?
Conversation
73f09e4
to
28556a3
Compare
Deployed adev-preview for 3adaddb to: https://ng-dev-previews-fw--pr-angular-angular-55836-adev-prev-a1iofovk.web.app Note: As new commits are pushed to this pull request, this link is updated after the preview is rebuilt. |
@@ -78,7 +78,7 @@ export const HAMMER_GESTURE_CONFIG = new InjectionToken<HammerGestureConfig>('Ha | |||
export type HammerLoader = () => Promise<void>; | |||
|
|||
/** | |||
* Injection token used to provide a {@link HammerLoader} to Angular. | |||
* Injection token used to provide a @see {@link HammerLoader} to Angular. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This creates a "pill" link. https://ng-dev-previews-fw--pr-angular-angular-55836-adev-prev-a1iofovk.web.app/api/platform-browser/HAMMER_LOADER
I think we should fix that when generating the template over on the dev-infra
repo.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes right, it looked a bit strange from a UX standpoint (but functional)- Also adding that @ see would omit the text after the referenced link. In the deployed version the "to Angular" last part of the sentence is now omitted. Maybe a rephrase would be better now to put the link last and look at both issues ? wdyt @JeanMeche ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Our template generator should be able to handle the link as is. I'd consider the curent behavior a bug.
What we could do is removing the link a go with a separate pill :
* Injection token used to provide a HammerLoader to Angular.
*
* @see {@link HammerLoader}
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
5a4fe07
to
a091e6d
Compare
Could you also make it a |
*Fixing broken documentation reference to HammerLoader in HammerLoaderInjectionToken page
a091e6d
to
3adaddb
Compare
Note: We'll wait for angular/dev-infra#2069 to be merge to likely amend this PR. |
I've the dev-infra update in #55888 but it turns out there is a bug in the typescript parsing, so we're stuck with an upstream issue. See |
@JeanMeche @bencodezen is this one ready to merge? Looking at the comments history I'm getting conflicting messages: it is ready for merge but also there is a comment from @JeanMeche saying that this is blocked: #55836 (comment) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We're waiting to land another fix
Fixes missing @ see to properly link to HammerLoader from Injection Token section