Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API doc should indicate when I should expect TextSearchMatchNew vs TextSearchContextNew in a text search result #223323

Closed
alexr00 opened this issue Jul 23, 2024 · 1 comment · Fixed by #224654
Assignees
Labels
insiders-released Patch has been released in VS Code Insiders polish Cleanup and polish issue search Search widget and operation issues search-api
Milestone

Comments

@alexr00
Copy link
Member

alexr00 commented Jul 23, 2024

Testing #223154

I can see that the result of findTextInFilesNew can be TextSearchMatchNew | TextSearchContextNew. When should I expect each of these types? I'm not sure I understand what the purpose of TextSearchContextNew is.

@andreamah
Copy link
Contributor

TextSearchContext is like the surrounding context lines that you see in the search editor.

Image

For example, here, lines 1791 and 1793 are context lines because they come directly before and after line 1792.

I can try to explain this better in the docs, though!

@andreamah andreamah added search Search widget and operation issues polish Cleanup and polish issue labels Jul 23, 2024
@andreamah andreamah added this to the August 2024 milestone Jul 23, 2024
@vs-code-engineering vs-code-engineering bot added the unreleased Patch has not yet been released in VS Code Insiders label Aug 2, 2024
@vs-code-engineering vs-code-engineering bot added insiders-released Patch has been released in VS Code Insiders and removed unreleased Patch has not yet been released in VS Code Insiders labels Aug 24, 2024
@vs-code-engineering vs-code-engineering bot locked and limited conversation to collaborators Sep 16, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
insiders-released Patch has been released in VS Code Insiders polish Cleanup and polish issue search Search widget and operation issues search-api
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants