gh-91888: add a `:gh:` role to the documentation #91889

ezio-melotti · 2022-04-24T19:49:48Z

This PR adds the :gh:`...` role proposed in GH-91888.

Some comments about the PR:

A :pr:`...` (or :gh-pr:) role could be added too
To be more explicit, we could also use :gh-issue:`...` instead of :gh:`...`
A :bpo:`...` alias to the :issue: role could be added, and :issue: deprecated

serhiy-storchaka

👍

hugovk

A few little suggestions.

Doc/tools/extensions/pyspecific.py

hugovk · 2022-04-25T07:25:40Z

A :pr:`...` (or :gh-pr:) role could be added too

To be more explicit, we could also use :gh-issue:`...` instead of :gh:`...`

A :bpo:`...` alias to the :issue: role could be added, and :issue: deprecated

People may end up using :gh:`...` for PRs as well, but it's not the end of the world: GitHub redirects
https://github.com/python/cpython/issues/91889 to
https://github.com/python/cpython/pull/91889

(And similarly redirects:
https://github.com/python/cpython/pull/91888 to
https://github.com/python/cpython/issues/91888)

Doc/tools/extensions/pyspecific.py

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

miss-islington · 2022-04-25T10:05:57Z

Thanks @ezio-melotti for the PR 🌮🎉.. I'm working now to backport this PR to: 3.7, 3.8, 3.9, 3.10.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington · 2022-04-25T10:06:01Z

Sorry, @ezio-melotti, I could not cleanly backport this to 3.10 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker f7641a2ffec243e5f600028a84debe9028a9ee44 3.10

miss-islington · 2022-04-25T10:06:03Z

Sorry @ezio-melotti, I had trouble checking out the 3.9 backport branch.
Please backport using cherry_picker on command line.
cherry_picker f7641a2ffec243e5f600028a84debe9028a9ee44 3.9

miss-islington · 2022-04-25T10:06:06Z

Sorry, @ezio-melotti, I could not cleanly backport this to 3.8 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker f7641a2ffec243e5f600028a84debe9028a9ee44 3.8

miss-islington · 2022-04-25T10:06:07Z

Sorry @ezio-melotti, I had trouble checking out the 3.7 backport branch.
Please backport using cherry_picker on command line.
cherry_picker f7641a2ffec243e5f600028a84debe9028a9ee44 3.7

…GH-91889) * Add a new :gh:`...` role for GitHub issues. * Fix a GitHub id to use the :gh: role. * Add Misc/NEWS entry. * Refactoring and rephrasing. Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>. (cherry picked from commit f7641a2) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

bedevere-bot · 2022-04-26T00:29:35Z

GH-91934 is a backport of this pull request to the 3.10 branch.

…GH-91889) * Add a new :gh:`...` role for GitHub issues. * Fix a GitHub id to use the :gh: role. * Add Misc/NEWS entry. * Refactoring and rephrasing. Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>. (cherry picked from commit f7641a2) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

bedevere-bot · 2022-04-26T00:38:05Z

GH-91935 is a backport of this pull request to the 3.9 branch.

…H-91889) * Add a new :gh:`...` role for GitHub issues. * Fix a GitHub id to use the :gh: role. * Add Misc/NEWS entry. * Refactoring and rephrasing. Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>. (cherry picked from commit f7641a2) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

bedevere-bot · 2022-04-26T00:40:35Z

GH-91936 is a backport of this pull request to the 3.8 branch.

…H-91889) * Add a new :gh:`...` role for GitHub issues. * Fix a GitHub id to use the :gh: role. * Add Misc/NEWS entry. * Refactoring and rephrasing. Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>. (cherry picked from commit f7641a2) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

bedevere-bot · 2022-04-26T00:42:31Z

GH-91937 is a backport of this pull request to the 3.7 branch.

) * gh-91888: Add a :gh: role to the documentation (GH-91889). * [3.10] gh-91888: add a `:gh:` role to the documentation (GH-91889) * Add a new :gh:`...` role for GitHub issues. * Fix a GitHub id to use the :gh: role. * Add Misc/NEWS entry. * Refactoring and rephrasing. Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>. (cherry picked from commit f7641a2) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

…1935) * gh-91888: Add a :gh: role to the documentation (GH-91889). * [3.9] gh-91888: add a `:gh:` role to the documentation (GH-91889) * Add a new :gh:`...` role for GitHub issues. * Fix a GitHub id to use the :gh: role. * Add Misc/NEWS entry. * Refactoring and rephrasing. Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>. (cherry picked from commit f7641a2) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

…-91937) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>. Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> (cherry picked from commit f7641a2)

…1936) * gh-91888: Add a :gh: role to the documentation (GH-91889). * [3.8] gh-91888: add a `:gh:` role to the documentation (GH-91889) * Add a new :gh:`...` role for GitHub issues. * Fix a GitHub id to use the :gh: role. * Add Misc/NEWS entry. * Refactoring and rephrasing. Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>. (cherry picked from commit f7641a2) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> * Fix use of the default role in NEWS entry

…H-91889) (python#91935) * pythongh-91888: Add a :gh: role to the documentation (pythonGH-91889). * [3.9] pythongh-91888: add a `:gh:` role to the documentation (pythonGH-91889) * Add a new :gh:`...` role for GitHub issues. * Fix a GitHub id to use the :gh: role. * Add Misc/NEWS entry. * Refactoring and rephrasing. Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>. (cherry picked from commit f7641a2) Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

ezio-melotti added 2 commits April 24, 2022 21:39

Add a new :gh:... role for GitHub issues.

d94e16a

Fix a GitHub id to use the :gh: role.

2a0173a

ezio-melotti self-assigned this Apr 24, 2022

bedevere-bot added the awaiting core review label Apr 24, 2022

serhiy-storchaka approved these changes Apr 24, 2022

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting core review labels Apr 24, 2022

Add Misc/NEWS entry.

208712c

ezio-melotti added needs backport to 3.7 needs backport to 3.9 only security fixes needs backport to 3.10 only security fixes labels Apr 24, 2022

ezio-melotti requested review from ambv and ned-deily April 24, 2022 21:30

hugovk reviewed Apr 25, 2022

View reviewed changes

Doc/tools/extensions/pyspecific.py Outdated Show resolved Hide resolved

Doc/tools/extensions/pyspecific.py Outdated Show resolved Hide resolved

Doc/tools/extensions/pyspecific.py Outdated Show resolved Hide resolved

Doc/tools/extensions/pyspecific.py Outdated Show resolved Hide resolved

ezio-melotti commented Apr 25, 2022

View reviewed changes

Doc/tools/extensions/pyspecific.py Outdated Show resolved Hide resolved

Refactoring and rephrasing.

3d902d3

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>

serhiy-storchaka approved these changes Apr 25, 2022

View reviewed changes

ezio-melotti merged commit f7641a2 into python:main Apr 25, 2022

bedevere-bot removed the awaiting merge label Apr 25, 2022

ezio-melotti added a commit to ezio-melotti/cpython that referenced this pull request Apr 26, 2022

pythongh-91888: Add a :gh: role to the documentation (pythonGH-91889).

cf4e09e

bedevere-bot removed the needs backport to 3.10 only security fixes label Apr 26, 2022

ezio-melotti added a commit to ezio-melotti/cpython that referenced this pull request Apr 26, 2022

pythongh-91888: Add a :gh: role to the documentation (pythonGH-91889).

1d2cc37

bedevere-bot removed the needs backport to 3.9 only security fixes label Apr 26, 2022

ezio-melotti added a commit to ezio-melotti/cpython that referenced this pull request Apr 26, 2022

pythongh-91888: Add a :gh: role to the documentation (pythonGH-91889).

ac050e9

bedevere-bot removed the needs backport to 3.8 label Apr 26, 2022

ezio-melotti added a commit to ezio-melotti/cpython that referenced this pull request Apr 26, 2022

pythongh-91888: Add a :gh: role to the documentation (pythonGH-91889).

a72fe03

bedevere-bot removed the needs backport to 3.7 label Apr 26, 2022

ezio-melotti deleted the new-role-gh branch April 26, 2022 00:43

kumaraditya303 mentioned this pull request May 9, 2022

Add a :gh: role to the documentation to link to GitHub issues #91888

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gh-91888: add a `:gh:` role to the documentation #91889

gh-91888: add a `:gh:` role to the documentation #91889

ezio-melotti commented Apr 24, 2022

serhiy-storchaka left a comment

hugovk left a comment

hugovk commented Apr 25, 2022

miss-islington commented Apr 25, 2022

miss-islington commented Apr 25, 2022

miss-islington commented Apr 25, 2022

miss-islington commented Apr 25, 2022

miss-islington commented Apr 25, 2022

bedevere-bot commented Apr 26, 2022 •

edited by ezio-melotti

Loading

bedevere-bot commented Apr 26, 2022

bedevere-bot commented Apr 26, 2022

bedevere-bot commented Apr 26, 2022

gh-91888: add a :gh: role to the documentation #91889

gh-91888: add a :gh: role to the documentation #91889

Conversation

ezio-melotti commented Apr 24, 2022

serhiy-storchaka left a comment

Choose a reason for hiding this comment

hugovk left a comment

Choose a reason for hiding this comment

hugovk commented Apr 25, 2022

miss-islington commented Apr 25, 2022

miss-islington commented Apr 25, 2022

miss-islington commented Apr 25, 2022

miss-islington commented Apr 25, 2022

miss-islington commented Apr 25, 2022

bedevere-bot commented Apr 26, 2022 • edited by ezio-melotti Loading

bedevere-bot commented Apr 26, 2022

bedevere-bot commented Apr 26, 2022

bedevere-bot commented Apr 26, 2022

gh-91888: add a `:gh:` role to the documentation #91889

gh-91888: add a `:gh:` role to the documentation #91889

bedevere-bot commented Apr 26, 2022 •

edited by ezio-melotti

Loading