Skip to content

Commit b68098f

Browse files
authored
search: discourage use of structural search (#1043)
The feature is off by default and we already encourage users to use regex or a combination of Search Jobs and custom scripts. This change formalizes the current state.
1 parent 7f838f5 commit b68098f

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/code-search/types/structural.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<p className="subtitle">Learn and understand about Sourcegraph's Structural Search and core functionality.</p>
44

5-
<Callout type="note"> Changed in version 5.3. Structural search is disabled by default. To enable it, ask your site administrator to set `experimentalFeatures.structuralSearch = "enabled" in site configuration. To make sure this functions properly, make sure you have "structuralSearch" : "enabled" nested within "experimentalFeatures".</Callout>
5+
<Callout type="note"> Changed in version 5.3. Structural search is disabled by default. To enable it, ask your site administrator to set experimentalFeatures.structuralSearch = "enabled" in site configuration. Structural search has performance limitations and is not actively developed. We recommend using regex search or a combination of [Search Jobs](./search-jobs.mdx) and custom scripts instead. Please reach out to [[email protected]](mailto:[email protected]) for guidance on alternative approaches.</Callout>
66

77
With structural search, you can match richer syntax patterns specifically in code and structured data formats like JSON. It can be awkward or difficult to match code blocks or nested expressions with regular expressions. To meet this challenge we've introduced a new and easier way to search code that operates more closely on a program's parse tree. We use [Comby syntax](https://comby.dev/docs/syntax-reference) for structural matching. Below you'll find examples and notes for this language-aware search functionality.
88

0 commit comments

Comments
 (0)