jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-29 18:00:57 -05:00
Code Issues Projects Releases Wiki Activity

Add cross-repo code navigation docs.

Browse Source 
This patch documents the expected behavior of the cross-repository code navigation feature for Python, including a screenshot of the associated UI.

Do not merge/publish until this feature is GA'd at Universe.

Part of https://github.com/orgs/github/projects/1799.
This commit is contained in:
Patrick Thomson
2022-11-01 15:10:16 -04:00
parent 86e2a32051
commit bcfe205e3d
2 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
assets/images/help/repository/cross-repository-code-navigation.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 114 KiB

6
content/repositories/working-with-files/using-files/navigating-code-on-github.md
View File

@@ -67,6 +67,12 @@ If you don't see the results you expect from a precise code navigation query, yo
If your precise results appear inaccurate, you can file a support request.
## Cross-repository precise code navigation
Languages that support precise code navigation support cross-repo requests. Thanks to cross-repo code navigation and the GitHub dependency graph, jump-to-definition requests for functions or variables defined in libraries used in your projects behave just like requests for entities defined in that project. By importing a function or variable from a third-party library hosted on Github, and then issuing a jump-to-definition request for that function or variable, you can click on the cross-repo result to its definition in the defining third-party library.
![Cross-repository code navigation](/assets/images/help/repository/cross-repository-code-navigation.png)
## Troubleshooting code navigation
If code navigation is enabled for you but you don't see links to the definitions of functions and methods: