Skip to content

/ angular

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

Jump to bottom

fix(docs-infra): TS generic parameter defaults are not preserved in API docs #37694

Open
gkalpak opened this issue Jun 23, 2020 · 5 comments
Open

fix(docs-infra): TS generic parameter defaults are not preserved in API docs #37694

gkalpak opened this issue Jun 23, 2020 · 5 comments
Assignees
@sonukapoor
Labels
comp: docs-infra type: bug/fix
Milestone
needsTriage

Comments

@gkalpak
Copy link
Member

@gkalpak gkalpak commented Jun 23, 2020 •
edited

TypeScript generic parameter defaults from source code do not show up in API docs.
For example, class ElementRef<T = any> { ... } (from the source code) appears as class ElementRef<T> { ... } in the API docs.
@ngbot ngbot bot modified the milestone: needsTriage Jun 23, 2020
@gkalpak gkalpak changed the title fix(docs-infra): generic parameter defaults are not preserved in API docs fix(docs-infra): TS generic parameter defaults are not preserved in API docs Jun 24, 2020
@petebacondarwin
Copy link
Member

@petebacondarwin petebacondarwin commented Jun 24, 2020

This is a bug in the typescript dgeni package.
@sonukapoor
Copy link
Contributor

@sonukapoor sonukapoor commented Jun 24, 2020

@gkalpak / @petebacondarwin I will take a look.
@petebacondarwin
Copy link
Member

@petebacondarwin petebacondarwin commented Jun 24, 2020

To get you started... take a look at this line: https://github.com/angular/dgeni-packages/blob/master/typescript/src/api-doc-types/ClassLikeExportDoc.ts#L33

and then consider this function https://github.com/angular/dgeni-packages/blob/master/typescript/src/services/TsParser/getDeclarationTypeText.ts
@sonukapoor
Copy link
Contributor

@sonukapoor sonukapoor commented Jun 24, 2020

Thanks for the pointer @petebacondarwin - that helps
@petebacondarwin
Copy link
Member

@petebacondarwin petebacondarwin commented Jun 27, 2020 •
edited

Should be fixed by @sonukapoor's PR: angular/dgeni-packages#290
Merged and released as 0.28.4
petebacondarwin added a commit to petebacondarwin/angular that referenced this issue Jun 27, 2020
@petebacondarwin
build(docs-infra): update to latest dgeni-packages
4882b74 
This update of dgeni-packages to 0.28.4 fixes the
rendering of type initializers for classes and interfaces.

Closes angular#37694
@petebacondarwin petebacondarwin mentioned this issue Jun 27, 2020
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sonukapoor sonukapoor

Labels
comp: docs-infra type: bug/fix
Projects
None yet
Milestone
  needsTriage
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
@petebacondarwin @sonukapoor @gkalpak
You can’t perform that action at this time.