Improve the punctuation for some errors

octogonz · octogonz · commit 6a73988d79c6 · 2019-04-12T13:36:45.000-07:00
diff --git a/apps/api-extractor/src/enhancers/DocCommentEnhancer.ts b/apps/api-extractor/src/enhancers/DocCommentEnhancer.ts
@@ -181,7 +181,7 @@ export class DocCommentEnhancer {
 
     if (!inheritDocTag.declarationReference) {
       this._collector.messageRouter.addAnalyzerIssue(ExtractorMessageId.UnresolvedInheritDocBase,
-        'The `@inheritDoc` tag needs a TSDoc declaration reference; signature matching is not supported yet',
+        'The @inheritDoc tag needs a TSDoc declaration reference; signature matching is not supported yet',
         astDeclaration);
       return;
     }
@@ -201,7 +201,7 @@ export class DocCommentEnhancer {
 
     if (referencedAstDeclaration instanceof ResolverFailure) {
       this._collector.messageRouter.addAnalyzerIssue(ExtractorMessageId.UnresolvedInheritDocReference,
-        'The `@inheritDoc` reference could not be resolved: ' + referencedAstDeclaration.reason, astDeclaration);
+        'The @inheritDoc reference could not be resolved: ' + referencedAstDeclaration.reason, astDeclaration);
       return;
     }
 
diff --git a/apps/api-extractor/src/enhancers/ValidationEnhancer.ts b/apps/api-extractor/src/enhancers/ValidationEnhancer.ts
@@ -40,8 +40,8 @@ export class ValidationEnhancer {
         if (exportName[0] !== '_') {
           collector.messageRouter.addAnalyzerIssue(
             ExtractorMessageId.InternalMissingUnderscore,
-            `The name ${exportName} should be prefixed with an underscore`
-            + ` because the declaration is marked as "@internal"`,
+            `The name "${exportName}" should be prefixed with an underscore`
+            + ` because the declaration is marked as @internal`,
             astSymbol,
             { exportName }
           );

Original file line number	Diff line number	Diff line change
`@@ -181,7 +181,7 @@ export class DocCommentEnhancer {`
`181`	`181`
`182`	`182`	`if (!inheritDocTag.declarationReference) {`
`183`	`183`	`this._collector.messageRouter.addAnalyzerIssue(ExtractorMessageId.UnresolvedInheritDocBase,`
`184`		- 'The `@inheritDoc` tag needs a TSDoc declaration reference; signature matching is not supported yet',
	`184`	`+ 'The @inheritDoc tag needs a TSDoc declaration reference; signature matching is not supported yet',`
`185`	`185`	`astDeclaration);`
`186`	`186`	`return;`
`187`	`187`	`}`
`@@ -201,7 +201,7 @@ export class DocCommentEnhancer {`
`201`	`201`
`202`	`202`	`if (referencedAstDeclaration instanceof ResolverFailure) {`
`203`	`203`	`this._collector.messageRouter.addAnalyzerIssue(ExtractorMessageId.UnresolvedInheritDocReference,`
`204`		- 'The `@inheritDoc` reference could not be resolved: ' + referencedAstDeclaration.reason, astDeclaration);
	`204`	`+ 'The @inheritDoc reference could not be resolved: ' + referencedAstDeclaration.reason, astDeclaration);`
`205`	`205`	`return;`
`206`	`206`	`}`
`207`	`207`