vscode-ltex icon indicating copy to clipboard operation
vscode-ltex copied to clipboard

Clarify documentation on `ltex.enabled`

Open haoadoreorange opened this issue 2 years ago • 4 comments

Nothing too serious, there's a line in the doc of ltex.enabled

The activation events are unaffected by this setting.

Reading this I thought that I could remove html from the list (it doesn't parse well html templates :cry:) and use the command Activate Extension to activate ltex per file regardless of ltex.enabled. Find out that's not the case at all.

haoadoreorange avatar May 18 '22 03:05 haoadoreorange

Isn't the behavior you describe exactly what the line says? It says, regardless of how you change this setting, LTEX will always be activated (meaning initialized by VS Code) for the default file types. It's just that once it has been activated checking will be enabled or, in your case, disabled for the specified/not specified languages, meaning that it will check/not check documents in those languages.

Do you have a concrete suggestion for how to make the line clearer (while still being concise)?

valentjn avatar May 18 '22 04:05 valentjn

Oh wait, so I din't even understand well what it does in the first place... Well I guess we should really clarify activate vs enable, because I thought it was synonymous.

It's just that once it has been activated checking will be enabled or, in your case, disabled for the specified/not specified languages, meaning that it will check/not check documents in those languages.

May be we should add this line to the doc ?

haoadoreorange avatar May 18 '22 16:05 haoadoreorange

I stumbled on this small issue too. The documentation is quite clear but I still find surprising that LTeX starts out as soon as I open a compatible file (say a markdown one) while I disabled LTeX checking for it.

laclouis5 avatar Jul 10 '22 14:07 laclouis5

I have the opposite issue. I added "python", to the list and LTex will not activate automatically when I open a Python file.

Tatsh avatar May 16 '23 04:05 Tatsh