Microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2026-05-02 14:31:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Very vague sentence about text encoding change (fix #241836) (#242019)

Browse Source
This commit is contained in:
Benjamin Pasero
2025-02-26 07:23:37 +01:00
committed by GitHub
parent 8e7f0bd987
commit 5b62c2e584
1 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/vscode-dts/vscode.proposed.textDocumentEncoding.d.ts vendored
View File

@@ -56,14 +56,16 @@ declare module 'vscode' {
/**
* The {@link TextDocument.encoding encoding} of the document to use
* for decoding the underlying buffer to text. If omitted, the encoding
* will be guessed based on the file content and/or the editor settings.
* will be guessed based on the file content and/or the editor settings
* unless the document is already opened.
*
* See {@link TextDocument.encoding} for more information about valid
* values for encoding.
*
* *Note* that opening a text document that was already opened with a
* different encoding has the potential of changing the text contents of
* the text document.
* the text document. Specifically, when the encoding results in a
* different set of characters than the previous encoding.
*/
encoding?: string;
}): Thenable<TextDocument>;
@@ -80,14 +82,16 @@ declare module 'vscode' {
/**
* The {@link TextDocument.encoding encoding} of the document to use
* for decoding the underlying buffer to text. If omitted, the encoding
* will be guessed based on the file content and/or the editor settings.
* will be guessed based on the file content and/or the editor settings
* unless the document is already opened.
*
* See {@link TextDocument.encoding} for more information about valid
* values for encoding.
*
* *Note* that opening a text document that was already opened with a
* different encoding has the potential of changing the text contents of
* the text document.
* the text document. Specifically, when the encoding results in a
* different set of characters than the previous encoding.
*/
encoding?: string;
}): Thenable<TextDocument>;