Skip to content
This repository was archived by the owner on Nov 6, 2018. It is now read-only.

Commit f33f8c4

Browse files
committed
fix(types): docstring for DocumentFilter
1 parent f018ebf commit f33f8c4

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

src/types/documents.ts

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
/**
2-
* A document filter denotes a document by different properties like
3-
* the [language](#TextDocument.languageId), the [scheme](#Uri.scheme) of
4-
* its resource, or a glob-pattern that is applied to the [path](#TextDocument.fileName).
2+
* A document filter denotes a document by different properties like the
3+
* [language](#TextDocument.languageId), the scheme of its resource, or a glob-pattern that is
4+
* applied to the [path](#TextDocument.fileName).
55
*
66
* @sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
77
* @sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**package.json' }`
88
*/
99
export type DocumentFilter =
1010
| {
11-
/** A language id, like `typescript`. */
11+
/** A language id, such as `typescript`. */
1212
language: string
13-
/** A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */
13+
/** A URI scheme, such as `file` or `untitled`. */
1414
scheme?: string
15-
/** A glob pattern, like `*.{ts,js}`. */
15+
/** A glob pattern, such as `*.{ts,js}`. */
1616
pattern?: string
1717
}
1818
| {
19-
/** A language id, like `typescript`. */
19+
/** A language id, such as `typescript`. */
2020
language?: string
21-
/** A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */
21+
/** A URI scheme, such as `file` or `untitled`. */
2222
scheme: string
23-
/** A glob pattern, like `*.{ts,js}`. */
23+
/** A glob pattern, such as `*.{ts,js}`. */
2424
pattern?: string
2525
}
2626
| {
27-
/** A language id, like `typescript`. */
27+
/** A language id, such as `typescript`. */
2828
language?: string
29-
/** A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */
29+
/** A URI scheme, such as `file` or `untitled`. */
3030
scheme?: string
31-
/** A glob pattern, like `*.{ts,js}`. */
31+
/** A glob pattern, such as `*.{ts,js}`. */
3232
pattern: string
3333
}
3434

0 commit comments

Comments
 (0)