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

Exclude not documented tweaks #1308

Merged

Conversation

canonic-epicure
Copy link
Contributor

This PR improves the --excludeNotDocumented behavior - it always includes all properties of the object type, if it has documentation (even if the properties do not have docs).

This seems to be an expected behavior for objects, which are used to document various structures in code, for example:

/**
 * Result type of `someMethod` (Object type has docs)
 */
export type SomeMethodResult = { noErrors : boolean, results : [] }

This behavior does not apply for classes/interfaces - for those if the property is not documented it is not included.

@Gerrit0 Gerrit0 merged commit e553af2 into TypeStrong:master Jun 28, 2020
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jun 28, 2020

Thanks! Should have a release later today.

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.

None yet

2 participants