Skip to content

Improve confusing error messages from api-extractor - #56

Merged
Dan Gaeta (dgaeta) merged 4 commits into
masterfrom
pgonzal/fix-errors
Jan 19, 2017
Merged

Improve confusing error messages from api-extractor#56
Dan Gaeta (dgaeta) merged 4 commits into
masterfrom
pgonzal/fix-errors

Conversation

@octogonz

Copy link
Copy Markdown
Collaborator

I got this error, which was confusing:

Warning - [apiExtractor] TypeScript error: Error formatting token tag: @inheritd
oc
  /some/path/SomeFile.ts#37
Warning - [apiExtractor] TypeScript error: Unexpected text. Text must either be
the first sentences of the JSDoc, or if too long for the first 2-3 sentences the
 text must be preceded by a @internalremarks tag.

The actual problem was that @inheritdoc (@inheritdoc) should have been specified as an inline tag, rather than a regular tag. Also, it is certainly not a "TypeScript error".

@dgaeta
Dan Gaeta (dgaeta) merged commit 1ce1822 into master Jan 19, 2017
Pete Gonzalez (octogonz) pushed a commit that referenced this pull request Feb 13, 2017
Improve confusing error messages from api-extractor
Christian Gonzalez (christiango) pushed a commit to christiango/web-build-tools that referenced this pull request Aug 22, 2017
Improve confusing error messages from api-extractor
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