Skip to content
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

Support for intersection type #482

Merged
merged 3 commits into from
Apr 24, 2017

Conversation

rklfss
Copy link
Contributor

@rklfss rklfss commented Apr 23, 2017

This PR introduces the support for intersection types (microsoft/TypeScript#3622).

I also added the type name identifiers ('void', 'reference', 'union' etc.) as a property to the type model to access them within themes (see TypeStrong/typedoc-default-themes#45).

rklfss added 3 commits April 22, 2017 09:12
This commit introduces the support for intersection types. Type name
identifiers are added as a model property to make them available to the
themes.
@@ -14,6 +14,11 @@ export class IntrinsicType extends Type {
name: string;

/**
* The type name identifier.
*/
readonly type: string = 'instrinct'; // TODO: Is there any change to correct this typo?
Copy link
Member

Choose a reason for hiding this comment

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

What do you think we should do here? I'm happy to accept the fix in a future PR. Just let me know what you think is needed to fix this!

Copy link
Member

@blakeembrey blakeembrey left a comment

Choose a reason for hiding this comment

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

This LGTM, I'll wait to find out what you think we should do about the typo 😄

@rklfss
Copy link
Contributor Author

rklfss commented Apr 23, 2017

It just continues the discussion on #146.

There's the argument not do change anything before 0.4 as it will break everyones code that relies on typedoc.

Now we have 0.5.x and just my two cents is, we should correct this (= every occurrence of "instrinct") to "intrinsic" - either with 0.6 or just now. I think it is not to late. Typedoc is in a relatively early state and everyone should be able to handle the "breaking change" with a simple replace-in-all-files action. Certainly it will be better than living with this pretty ugly typo for the rest of our lives ;)

@blakeembrey
Copy link
Member

I'm definitely happy to have it fixed and I would just bump the minor and document the occurance. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants