X Tutup
Skip to content

fix(docs): update link paths in annotations#2475

Closed
jeffbcross wants to merge 1 commit intoangular:masterfrom
jeffbcross:fix-annotations-links
Closed

fix(docs): update link paths in annotations#2475
jeffbcross wants to merge 1 commit intoangular:masterfrom
jeffbcross:fix-annotations-links

Conversation

@jeffbcross
Copy link
Copy Markdown
Contributor

Partial fix to #2452

@jeffbcross jeffbcross added comp: docs action: review The PR is still awaiting reviews from at least one requested reviewer labels Jun 11, 2015
@jeffbcross jeffbcross added this to the alpha-27 milestone Jun 11, 2015
@jeffbcross
Copy link
Copy Markdown
Contributor Author

@petebacondarwin mind taking a look (small change)?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm

@jeffbcross
Copy link
Copy Markdown
Contributor Author

@petebacondarwin I updated the links in annotations to point to local anchors.

@petebacondarwin
Copy link
Copy Markdown
Contributor

I just ran this with gulp docs and it still gives errors:

warn:    Invalid link (does not match any doc): "KeyValueChanges" - doc "properties" (member)  - from file "angular2/src/core/annotations_impl/annotations.ts"
warn:    Invalid link (does not match any doc): "KeyValueChanges" - doc "DirectiveAnnotation extends  Injectable" (class)  - from file "angular2/src/core/annotations_impl/annotations.ts"
warn:    Dangling Links Found in "partials/modules//angular2/angular2/DirectiveAnnotation extends  Injectable/index.html":
 - QueryList,
 - QueryList,
 - #onChange,
 - #onDestroy,
 - #onAllChangesDone,
 - KeyValueChanges

etc

@jeffbcross
Copy link
Copy Markdown
Contributor Author

@petebacondarwin that's related to the heritage-in-name issue that you fixed. Running against rebased master gets rid of those complaints.

@jeffbcross
Copy link
Copy Markdown
Contributor Author

I take that back. With the hash urls pointing to events, I still get dangling link issues. And if I use plain old names like {@link onDestroy}, I get "Ambiguous Link" warnings.

It seems the only combination that doesn't have errors is:

/**
 * See {@link /angular2/annotations/onChange}, {@link /angular2/annotations/onDestroy}, {@link /angular2/annotations/onCheck},
 * {@link /angular2/annotations/onInit}, {@link /angular2/annotations/onAllChangesDone} for details.
**/

@petebacondarwin
Copy link
Copy Markdown
Contributor

I fixed the id and alias generation for members and exports and this got rid of those last problems.

petebacondarwin added a commit that referenced this pull request Jun 14, 2015
This helps to ensure that links to exports are not confused with links
to members, which was causing some missing link issues.

Helps #2475
@angular-automatic-lock-bot
Copy link
Copy Markdown

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 6, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

action: review The PR is still awaiting reviews from at least one requested reviewer cla: yes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

X Tutup