Documentation for `lineComment` in `language-configuration.json` is out-of-date

[eisenwave]

vscode-docs/api/language-extensions/language-configuration-guide.md

Lines 28 to 31 in 0a4ca79

	"comments": {
	"lineComment": "//",
	"blockComment": ["/*", "*/"]
	},

Following this format gives me a warning:

That is because at some point, the lineComment property got expanded from being just a string to being an object with comment and noIndent property.

https://github.com/microsoft/vscode/blob/d2894816734dc9141885b802805801b67d70e6e9/src/vs/workbench/contrib/codeEditor/common/languageConfigurationExtensionPoint.ts#L549C5-L565

[DakotaB75]

I’ll take this.

The guide still shows lineComment as a string, but the configuration now supports an object form (comment, noIndent).
I’ll update the example and text to reflect the current format and avoid the warning.

[ntrogh]

@eisenwave Thanks for reporting this. The language configuration JSON defines lineComment as on object however the extension API supports both string and object. So, the language configuration definition should be updated to type: ['string', 'object'], instead. Issue created in vscode repo: microsoft/vscode#285594

In addition, the API docs should be updated to describe both configuration formats (string and object).

[DakotaB75]

Documented both supported lineComment formats in the language configuration guide.