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

Fix backticks in our JSDoc comments #50737

Merged
merged 2 commits into from Sep 12, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/lib/es2015.proxy.d.ts
Expand Up @@ -78,7 +78,7 @@ interface ProxyHandler<T extends object> {
* @param target The original object which is being proxied.
* @param p The name or `Symbol` of the property to set.
* @param receiver The object to which the assignment was originally directed.
* @returns `A `Boolean` indicating whether or not the property was set.
* @returns A `Boolean` indicating whether or not the property was set.
*/
set?(target: T, p: string | symbol, newValue: any, receiver: any): boolean;

Expand Down
10 changes: 5 additions & 5 deletions src/services/codefixes/helpers.ts
Expand Up @@ -70,11 +70,11 @@ namespace ts.codefix {
* `MappedIndirect.ax` and `MappedIndirect.ay` have no declaration node attached (due to their mapped-type
* parent):
*
* >>> ```ts
* >>> type Base = { ax: number; ay: string };
* >>> type BaseKeys = keyof Base;
* >>> type MappedIndirect = { [K in BaseKeys]: boolean };
* >>> ```
* ```ts
* type Base = { ax: number; ay: string };
* type BaseKeys = keyof Base;
* type MappedIndirect = { [K in BaseKeys]: boolean };
* ```
*
* In such cases, we assume the declaration to be a `PropertySignature`.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/services/types.ts
Expand Up @@ -1214,7 +1214,7 @@ namespace ts {
isGlobalCompletion: boolean;
isMemberCompletion: boolean;
/**
* In the absence of `CompletionEntry["replacementSpan"], the editor may choose whether to use
* In the absence of `CompletionEntry["replacementSpan"]`, the editor may choose whether to use
* this span or its default one. If `CompletionEntry["replacementSpan"]` is defined, that span
* must be used to commit that completion entry.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/services/utilities.ts
Expand Up @@ -1659,7 +1659,7 @@ namespace ts {
/**
* Returns true if the cursor at position in sourceFile is within a comment.
*
* @param tokenAtPosition Must equal `getTokenAtPosition(sourceFile, position)
* @param tokenAtPosition Must equal `getTokenAtPosition(sourceFile, position)`
* @param predicate Additional predicate to test on the comment range.
*/
export function isInComment(sourceFile: SourceFile, position: number, tokenAtPosition?: Node): CommentRange | undefined {
Expand Down
2 changes: 1 addition & 1 deletion tests/baselines/reference/api/tsserverlibrary.d.ts
Expand Up @@ -6547,7 +6547,7 @@ declare namespace ts {
isGlobalCompletion: boolean;
isMemberCompletion: boolean;
/**
* In the absence of `CompletionEntry["replacementSpan"], the editor may choose whether to use
* In the absence of `CompletionEntry["replacementSpan"]`, the editor may choose whether to use
* this span or its default one. If `CompletionEntry["replacementSpan"]` is defined, that span
* must be used to commit that completion entry.
*/
Expand Down
2 changes: 1 addition & 1 deletion tests/baselines/reference/api/typescript.d.ts
Expand Up @@ -6547,7 +6547,7 @@ declare namespace ts {
isGlobalCompletion: boolean;
isMemberCompletion: boolean;
/**
* In the absence of `CompletionEntry["replacementSpan"], the editor may choose whether to use
* In the absence of `CompletionEntry["replacementSpan"]`, the editor may choose whether to use
* this span or its default one. If `CompletionEntry["replacementSpan"]` is defined, that span
* must be used to commit that completion entry.
*/
Expand Down