Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create URL links to actual PRs rather than simply referencing the PR number #4258

Closed
gandhis1 opened this issue Feb 28, 2024 · 2 comments · Fixed by #4346
Closed

Create URL links to actual PRs rather than simply referencing the PR number #4258

gandhis1 opened this issue Feb 28, 2024 · 2 comments · Fixed by #4346
Labels
T: documentation Improvements to the docs (e.g. new topic, correction, etc)

Comments

@gandhis1
Copy link

gandhis1 commented Feb 28, 2024

The change log is immensely useful, however it makes reference to specific Github PRs and only mentions the PR number without actually linking to the issue.

I would like for the changelog to actually include links to the issue. It would be of great help to readers to be able to see the contextual discussion for a change, particularly for style changes.

https://black.readthedocs.io/en/stable/change_log.html

@gandhis1 gandhis1 added the T: documentation Improvements to the docs (e.g. new topic, correction, etc) label Feb 28, 2024
@JelleZijlstra
Copy link
Collaborator

That would be very useful; there's probably something we can do in Sphinx to transform the references to links. Contributions welcome!

Note the links are to PRs, not issues.

@gandhis1 gandhis1 changed the title Create URL links to actual issues rather than simply referencing the issue number Create URL links to actual PRs rather than simply referencing the PR number Feb 28, 2024
@sumezulike
Copy link
Contributor

I've implemented this, but it requires executablebooks/MyST-Parser#887, so waiting on that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T: documentation Improvements to the docs (e.g. new topic, correction, etc)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants