X Tutup
Skip to content

fix(docs): export simple name and full name for doc alias#2462

Closed
jeffbcross wants to merge 1 commit intoangular:masterfrom
jeffbcross:fix-docs-errors
Closed

fix(docs): export simple name and full name for doc alias#2462
jeffbcross wants to merge 1 commit intoangular:masterfrom
jeffbcross:fix-docs-errors

Conversation

@jeffbcross
Copy link
Copy Markdown
Contributor

(Still needs fix to the dangling link warnings, possibly in the dgeni-packages repo)

Fixes #2452

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

I don't really like this because it doesn't solve the problem that the id of the document should IMO include information (as a string) about the extend parentage of the class. I think the document's id should just be the class name prefixed by module.

We should expose the heritage in separate properties that can be consumed by the .d.ts processing. This would keep the readTypeScriptModules processor decoupled from the final output format.

@jeffbcross
Copy link
Copy Markdown
Contributor Author

@petebacondarwin I'm not following. You say "the id of the document should IMO include information (as a string) about the extend parentage of the class." And then you say, "the document's id should just be the class name prefixed by module." I think you used incorrect terminology in one of those sentences.

@jeffbcross
Copy link
Copy Markdown
Contributor Author

In my commit, the id remains a string with parentage information, but additional aliases are added to include the full parentage and generic information, as well as a trimmed version.

@jeffbcross
Copy link
Copy Markdown
Contributor Author

BTW, this is my first foray into Dgeni, so I'm kinda flying blind. When you say "consumed by the .d.ts processing," are you referring to the logic contained within the readTypeScriptModules.js module?

@jeffbcross
Copy link
Copy Markdown
Contributor Author

(Updated the commit to include inline comment about the change, and to fix a link in annotations.ts)

@petebacondarwin
Copy link
Copy Markdown
Contributor

Sorry I mean IMO "not" include that information.

You are flying straight and true - just don't let go of the stick.

What I am saying is that Alex Eagle's change was wrong, that it should be reverted and a different solution found.

@jeffbcross
Copy link
Copy Markdown
Contributor Author

@petebacondarwin sounds good, I'll go ahead and revert it and push to this PR.

@jeffbcross
Copy link
Copy Markdown
Contributor Author

Hmm, that commit does a lot of things. I'd rather not revert the commit, and I'm not sure the implications if I just remove parts of it.

How about I change my commit to set the id of the doc to the trimmed version, and keep the name as-is? Then existing links should be happy, and the templates would still be displaying the name with full heritage.

@petebacondarwin
Copy link
Copy Markdown
Contributor

Working in it right now.

@jeffbcross
Copy link
Copy Markdown
Contributor Author

Closed in favor of 659adf8

@jeffbcross jeffbcross closed this Jun 11, 2015
@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 type: bug/fix

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix(docs): resolve warnings logged by gulp public_docs task

3 participants

X Tutup