Skip to content

Commit 80fcab8

Browse files
[Docs][clang-query] disclose Windows linetab bug on clang-query tab auto-complete (#107956)
As per #106672 and #107377, the documentation should be updated to note that the current bug on Windows involving ``LineEditor`` causing Tab key related features to not work. Fixes #107377
1 parent b9c2e2e commit 80fcab8

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

clang-tools-extra/docs/clang-tidy/Contributing.rst

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -344,18 +344,20 @@ matching expressions to simplify your matcher.
344344
clang-query> let c1 cxxRecordDecl()
345345
clang-query> match c1
346346
347-
Alternatively, pressing the tab key after a previous matcher's open parentheses would also
348-
show which matchers can be chained with the previous matcher, though some matchers that work
349-
may not be listed.
350-
351-
Just like breaking up a huge function into smaller chunks with intention-revealing names
352-
can help you understand a complex algorithm, breaking up a matcher into smaller matchers
353-
with intention-revealing names can help you understand a complicated matcher.
354-
355-
Once you have a working clang-query matcher, the C++ API matchers will be the same or similar
356-
to your interactively constructed matcher (there can be cases where they differ slightly).
357-
You can use local variables to preserve your intention-revealing names that you applied
358-
to nested matchers.
347+
Alternatively, pressing the tab key after a previous matcher's open parentheses
348+
would also show which matchers can be chained with the previous matcher,
349+
though some matchers that work may not be listed. Note that tab completion
350+
does not currently work on Windows.
351+
352+
Just like breaking up a huge function into smaller chunks with
353+
intention-revealing names can help you understand a complex algorithm, breaking
354+
up a matcher into smaller matchers with intention-revealing names can help
355+
you understand a complicated matcher.
356+
357+
Once you have a working :program:`clang-query` matcher, the C++ API matchers
358+
will be the same or similar to your interactively constructed matcher (there
359+
can be cases where they differ slightly). You can use local variables to preserve
360+
your intention-revealing names that you applied to nested matchers.
359361

360362
Creating private matchers
361363
^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)