Skip to content

Commit 6130cc3

Browse files
Expand section on links
1 parent 5690215 commit 6130cc3

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

triage/issue-tracker.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -150,9 +150,12 @@ The following abbreviations can be used in a comment to generate a link:
150150

151151
See also the `list of autolinks supported by GitHub <autolinks_>`_.
152152

153-
To link to files in the repository, use Markdown links. If you link to
154-
the default GitHub path, the file will link to the latest current
155-
version on the given branch.
153+
To link to a file in the repository, use a Markdown link with the path
154+
of the file relative to the repository root, for example
155+
``[the os module docs](Doc/library/os.rst)``. In issues, such links
156+
point to the latest version of the file on the default branch. In PRs,
157+
they are resolved against the PR's branch instead, so prefer permanent
158+
links there.
156159

157160
You can get a permanent link to a given revision of a given file by
158161
`pressing "y" <https://docs.github.com/en/repositories/working-with-files/using-files/getting-permanent-links-to-files>`__.

0 commit comments

Comments
 (0)