What is the intent of TextSearchPreviewOptions.maxLines?

[bpasero]

Refs: #57305

I tried changing the TextSearchPreviewOptions.maxLines setting but could never see more than one line showing up. How to use it?

[roblourens]

Multiline search isn't supported yet by the builtin search provider. (I should add a comment to that effect). When it is, this would let consumers request lines in the preview. It won't change the number of actual lines that the match can contain, just text lines in the preview.

For example, vscode will just display the first line in the search viewlet. But, an extension that shows results in an editor might want to show the first 5 lines of a match.

[bpasero]

Ah, so this travels potentially to an extension that provides search, but is currently not supported by our built in search?

[roblourens]

Correct

[roblourens]

The builtin provider will probably support it in a month or two.

[bpasero]

Maybe this should be documented so that it does not draw the wrong assumptions.