зеркало из https://github.com/github/docs.git
Update languages supported for code navigation (#50739)
Co-authored-by: Rachael Rose Renk <91027132+rachaelrenk@users.noreply.github.com>
This commit is contained in:
Luke Francl
GitHub
Родитель
cadec7d123
Коммит
8927cb753a
|
|
@ -23,19 +23,28 @@ Code navigation uses the open source [`tree-sitter`](https://github.com/tree-sit
|
|||
|
||||
{% rowheaders %}
|
||||
|
||||
| Language | Search-based code navigation | Precise code navigation |
|
||||
|:----------:|:----------------------------:|:-----------------------:|
|
||||
| C# | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| CodeQL | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| Elixir | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| Go | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| Java | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| JavaScript | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| PHP | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| Python | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
|
||||
| Ruby | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| Rust | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| TypeScript | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
|
||||
| Language | Search-based code navigation | Precise code navigation |
|
||||
|------------------|:--------------------------------------------:|:--------------------------------------------:|
|
||||
| Bash | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| C | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| C# | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| C++ | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| CodeQL | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| Elixir | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| Go | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| JSX | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| Java | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| JavaScript | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| Lua | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| PHP | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| Protocol Buffers | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| Python | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
|
||||
| Ruby | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| Rust | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| Scala | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| Starlark | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| Swift | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} |
|
||||
| TypeScript | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
|
||||
|
||||
{% endrowheaders %}
|
||||
|
||||
|
|
|
|||
|
|
@ -18,6 +18,14 @@ Code search is integrated with features in the search interface on {% data varia
|
|||
|
||||
{% data reusables.search.non-code-search-explanation %}
|
||||
|
||||
## Code navigation
|
||||
|
||||
{% data variables.product.prodname_dotcom %} code search provides code navigation for supported languages. This includes jumping to the definition of and finding references for programming language constructs like classes, structs, functions, and methods. See "[AUTOTITLE](/repositories/working-with-files/using-files/navigating-code-on-github)."
|
||||
|
||||
Supported languages for code navigation include:
|
||||
|
||||
{% data reusables.search.code-nav-supported-languages %}
|
||||
|
||||
## Limitations
|
||||
|
||||
We have indexed many public repositories for code search, and continue to index more. Additionally, the private repositories of {% data variables.product.prodname_dotcom%} users are indexed and searchable by those that already have access to those private repositories on {% data variables.product.prodname_dotcom_the_website %}. However, very large repositories may not be indexed at this time, and not all code is indexed.
|
||||
|
|
|
|||
|
|
@ -238,18 +238,9 @@ You can also use regular expressions with the symbol qualifier. For example, the
|
|||
language:rust symbol:/^String::to_.*/
|
||||
```
|
||||
|
||||
Note that this qualifier only searches for definitions and not references, and not all symbol types or languages are fully supported yet. Symbol extraction is supported for the following languages.
|
||||
Note that this qualifier only searches for definitions and not references, and not all symbol types or languages are fully supported yet. Symbol extraction is supported for the following languages:
|
||||
|
||||
- C#
|
||||
- Python
|
||||
- Go
|
||||
- Java
|
||||
- JavaScript
|
||||
- TypeScript
|
||||
- PHP
|
||||
- Protocol Buffers
|
||||
- Ruby
|
||||
- Rust
|
||||
{% data reusables.search.code-nav-supported-languages %}
|
||||
|
||||
We are working on adding support for more languages. If you would like to help contribute to this effort, you can add support for your language in the open source [Tree-sitter](https://github.com/tree-sitter) parser ecosystem, upon which symbol search is based.
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,20 @@
|
|||
- Bash
|
||||
- C
|
||||
- C#
|
||||
- C++
|
||||
- CodeQL
|
||||
- Elixir
|
||||
- Go
|
||||
- JSX
|
||||
- Java
|
||||
- JavaScript
|
||||
- Lua
|
||||
- PHP
|
||||
- Protocol Buffers
|
||||
- Python
|
||||
- Ruby
|
||||
- Rust
|
||||
- Scala
|
||||
- Starlark
|
||||
- Swift
|
||||
- Typescript
|
||||
Загрузка…
Ссылка в новой задаче