diff --git a/assets/images/help/repository/code-navigation-popover.png b/assets/images/help/repository/code-navigation-popover.png new file mode 100644 index 0000000000..112208fea5 Binary files /dev/null and b/assets/images/help/repository/code-navigation-popover.png differ diff --git a/assets/images/help/repository/search-based-code-navigation-link.png b/assets/images/help/repository/search-based-code-navigation-link.png new file mode 100644 index 0000000000..d664f6aad8 Binary files /dev/null and b/assets/images/help/repository/search-based-code-navigation-link.png differ diff --git a/content/repositories/working-with-files/using-files/navigating-code-on-github.md b/content/repositories/working-with-files/using-files/navigating-code-on-github.md index 7e4246ba15..d0f6114565 100644 --- a/content/repositories/working-with-files/using-files/navigating-code-on-github.md +++ b/content/repositories/working-with-files/using-files/navigating-code-on-github.md @@ -15,16 +15,34 @@ topics: ## About navigating code on {% data variables.product.prodname_dotcom %} -Code navigation uses the open source library [`tree-sitter`](https://github.com/tree-sitter/tree-sitter). The following languages are supported: -- C# -- CodeQL -- Go -- Java -- JavaScript -- PHP -- Python -- Ruby -- TypeScript +Code navigation helps you to read, navigate, and understand code by showing and linking definitions of a named entity corresponding to a reference to that entity, as well as references corresponding to an entity's definition. + +![Code navigation display](/assets/images/help/repository/code-navigation-popover.png) + +Code navigation uses the open source [`tree-sitter`](https://github.com/tree-sitter/tree-sitter) library. The following languages and navigation strategies are supported: + +| Language | search-based code navigation | precise code navigation | +|:----------:|:----------------------------:|:-----------------------:| +| C# | ✅ | | +| CodeQL | ✅ | | +| Go | ✅ | | +| Java | ✅ | | +| JavaScript | ✅ | | +| PHP | ✅ | | +| Python | ✅ | ✅ | +| Ruby | ✅ | | +| TypeScript | ✅ | | + + +You do not need to configure anything in your repository to enable code navigation. We will automatically extract search-based and precise code navigation information for these supported languages in all repositories and you can switch between the two supported code navigation approaches if your programming language is supported by both. + +{% data variables.product.prodname_dotcom %} has developed two code navigation approaches based on the open source [`tree-sitter`](https://github.com/tree-sitter/tree-sitter) and [`stack-graphs`](https://github.com/github/stack-graphs) library: + - search-based - searches all definitions and references across a repository to find entities with a given name + - precise - resolves definitions and references based on the set of classes, functions, and imported definitions at a given point in your code + +To learn more about these approaches, see "[Precise and search-based navigation](#precise-and-search-based-navigation)." + +Future releases will add *precise code navigation* for more languages, which is a code navigation approach that can give more accurate results. ## Jumping to the definition of a function or method @@ -38,11 +56,21 @@ You can find all references for a function or method within the same repository ![Find all references tab](/assets/images/help/repository/find-all-references-tab.png) +## Precise and search-based navigation + +Certain languages supported by {% data variables.product.prodname_dotcom %} have access to *precise code navigation*, which uses an algorithm (based on the open source [`stack-graphs`](https://github.com/github/stack-graphs) library) that resolves definitions and references based on the set of classes, functions, and imported definitions that are visible at any given point in your code. Other languages use *search-based code navigation*, which searches all definitions and references across a repository to find entities with a given name. Both strategies are effective at finding results and both make sure to avoid inappropriate results such as comments, but precise code navigation can give more accurate results, especially when a repository contains multiple methods or functions with the same name. + +If you don't see the results you expect from a precise code navigation query, you can click on the "search-based" link in the displayed popover to perform search-based navigation. + +![Search-based code navigation link](/assets/images/help/repository/search-based-code-navigation-link.png) + +If your precise results appear inaccurate, you can file a support request. + ## Troubleshooting code navigation If code navigation is enabled for you but you don't see links to the definitions of functions and methods: - Code navigation only works for active branches. Push to the branch and try again. -- Code navigation only works for repositories with less than 100,000 files. +- Code navigation only works for repositories with fewer than 100,000 files. ## Further reading - "[Searching code](/github/searching-for-information-on-github/searching-code)" diff --git a/data/reusables/supported-languages/python.md b/data/reusables/supported-languages/python.md index 25d65a92de..5aceab7e45 100644 --- a/data/reusables/supported-languages/python.md +++ b/data/reusables/supported-languages/python.md @@ -1 +1 @@ -| Python {% ifversion fpt or ghec %}| {% octicon "check" aria-label="The check icon" %} | {% octicon "check" aria-label="The check icon" %} | {% octicon "check" aria-label="The check icon" %}
pip | {% octicon "check" aria-label="The check icon" %}
pip | {% octicon "check" aria-label="The check icon" %} | {% octicon "x" aria-label="The X icon" %} |{% elsif ghes %}| {% octicon "check" aria-label="The check icon" %} | {% octicon "check" aria-label="The check icon" %}
pip {% ifversion ghes > 3.2 %}| {% octicon "check" aria-label="The check icon" %}
pip{% endif %} | {% octicon "check" aria-label="The check icon" %} | {% octicon "x" aria-label="The X icon" %} |{% elsif ghae %}| {% octicon "check" aria-label="The check icon" %} | {% octicon "check" aria-label="The check icon" %} | {% octicon "x" aria-label="The X icon" %} |{% endif %} +| Python {% ifversion fpt or ghec %}| {% octicon "check" aria-label="The check icon" %}
precise| {% octicon "check" aria-label="The check icon" %} | {% octicon "check" aria-label="The check icon" %}
pip | {% octicon "check" aria-label="The check icon" %}
pip | {% octicon "check" aria-label="The check icon" %} | {% octicon "x" aria-label="The X icon" %} |{% elsif ghes %}| {% octicon "check" aria-label="The check icon" %} | {% octicon "check" aria-label="The check icon" %}
pip {% ifversion ghes > 3.2 %}| {% octicon "check" aria-label="The check icon" %}
pip{% endif %} | {% octicon "check" aria-label="The check icon" %} | {% octicon "x" aria-label="The X icon" %} |{% elsif ghae %}| {% octicon "check" aria-label="The check icon" %} | {% octicon "check" aria-label="The check icon" %} | {% octicon "x" aria-label="The X icon" %} |{% endif %} diff --git a/tests/meta/repository-references.js b/tests/meta/repository-references.js index 82839218a7..a1523294ff 100644 --- a/tests/meta/repository-references.js +++ b/tests/meta/repository-references.js @@ -53,6 +53,7 @@ const PUBLIC_REPOS = new Set([ 'hello-world.git', 'insights-releases', 'help-docs-archived-enterprise-versions', + 'stack-graphs', ]) const ALLOW_DOCS_PATHS = [