-
Notifications
You must be signed in to change notification settings - Fork 712
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
Add typeArguments to ReferenceType.toString() #396
Conversation
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.
LGTM, with some possible suggestions.
src/lib/models/types/reference.ts
Outdated
@@ -17,7 +17,7 @@ export class ReferenceType extends Type | |||
* If the symbol cannot be found cause it's not part of the documentation this | |||
* can be used to represent the type. | |||
*/ | |||
name:string; | |||
name:string; |
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.
Looks like a space was accidentally added here.
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.
I actually thought that my editor removed a trailing space :D Will fix it!
src/lib/models/types/reference.ts
Outdated
@@ -115,10 +115,15 @@ export class ReferenceType extends Type | |||
* Return a string representation of this type. | |||
*/ |
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.
It might be helpful to add an example output string to the method docs
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.
You're right. I was also looking for some test for the class but I didn't it. Is there any? Thanks for your review (:
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.
You're welcome. I don't think there is currently a test set up. The travis build seems to have run fine.
I updated after your suggestions. I added also a commit because many test files were updated by, I suppose, a |
Great! Having the example output helps clarify what is going on. I'm surprised that the domain wasn't changed before. Ideally that would have been done in a separate PR. |
No problem, I removed the last commit (: |
Any update? Are you @aciccarello allowed to merge PRs? You're helping a lot in issues too, would be sad to leave the project inactive. |
@blakeembrey thanks for merging (: do you have any thoughts about adding collaborators to the project to keep it alive if you don't have much time? |
If someone is willing to take on the work, I'm certainly happy to add them as a maintainer and collaborator. I added @aciccarello for that reason 😄 He also linked to the related issues which should shed more light - I do hope to give this project to someone who can take it to the right place eventually, since that person is not currently me. |
First of all good job for the hard work on this project! ❤️
I'm using the
Converter
API to generate custom documentation for Angular components and I noticed thattypeArguments
are missing when calling.toString()
on aReferenceType
.