gh-106919: Use role :c:macro: for referencing the C "constants" by serhiy-storchaka · Pull Request #106920 · python/cpython

serhiy-storchaka · 2023-07-20T17:58:09Z

Issue: Use proper markup for the C "constants" #106919

📚 Documentation preview 📚: https://cpython-previews--106920.org.readthedocs.build/

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

erlend-aasland · 2023-07-20T19:30:52Z


 It is possible to pass "long" integers (integers whose value exceeds the
-platform's :const:`LONG_MAX`) however no proper range checking is done --- the
+platform's :c:macro:`LONG_MAX`) however no proper range checking is done --- the


Suggested change

platform's :c:macro:`LONG_MAX`) however no proper range checking is done --- the

platform's :c:macro:`!LONG_MAX`) however no proper range checking is done --- the

I think that it may be better to solve this for standard C names globally.

erlend-aasland

LGTM, with one nit. Thanks!

ezio-melotti

LGTM!

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

miss-islington · 2023-07-21T07:52:11Z

Thanks @serhiy-storchaka for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

miss-islington · 2023-07-21T07:52:15Z

Sorry, @serhiy-storchaka, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker fcc816dbff7ca66c26f57a506e4d2330fe41d0ff 3.12

miss-islington · 2023-07-21T07:52:17Z

Sorry @serhiy-storchaka, I had trouble checking out the 3.11 backport branch.
Please retry by removing and re-adding the "needs backport to 3.11" label.
Alternatively, you can backport using cherry_picker on the command line.
cherry_picker fcc816dbff7ca66c26f57a506e4d2330fe41d0ff 3.11

…stants" (pythonGH-106920). (cherry picked from commit fcc816d) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

bedevere-bot · 2023-07-21T09:18:30Z

GH-106951 is a backport of this pull request to the 3.12 branch.

…stants" (pythonGH-106920). (cherry picked from commit fcc816d) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

bedevere-bot · 2023-07-21T09:28:49Z

GH-106952 is a backport of this pull request to the 3.11 branch.

GH-106920) (GH-106951) (cherry picked from commit fcc816d)

GH-106920) (GH-106952) (cherry picked from commit fcc816d)

pythongh-106919: Use role :c:macro: for referencing the C "constants"

b19c29f

serhiy-storchaka added skip news needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Jul 20, 2023

serhiy-storchaka requested review from erlend-aasland, ezio-melotti and vstinner July 20, 2023 17:58

serhiy-storchaka requested a review from encukou as a code owner July 20, 2023 17:58

bedevere-bot mentioned this pull request Jul 20, 2023

Use proper markup for the C "constants" #106919

Closed

bedevere-bot added awaiting core review docs Documentation in the Doc dir labels Jul 20, 2023

erlend-aasland reviewed Jul 20, 2023

View reviewed changes

Comment thread Doc/c-api/slice.rst Outdated

Comment thread Doc/c-api/exceptions.rst Outdated

Comment thread Doc/c-api/exceptions.rst Outdated

Comment thread Doc/c-api/call.rst

serhiy-storchaka and others added 2 commits July 20, 2023 21:36

Apply suggestions from code review

d41eba4

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>

Use explicit label names in references.

c16e6e4

erlend-aasland reviewed Jul 20, 2023

View reviewed changes

erlend-aasland approved these changes Jul 20, 2023

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting core review labels Jul 20, 2023

ezio-melotti approved these changes Jul 21, 2023

View reviewed changes

Comment thread Doc/c-api/structures.rst Outdated

Update Doc/c-api/structures.rst

81b5927

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

serhiy-storchaka merged commit fcc816d into python:main Jul 21, 2023

bedevere-bot removed the awaiting merge label Jul 21, 2023

serhiy-storchaka deleted the docs-c-macro-roles branch July 21, 2023 07:52

miss-islington assigned serhiy-storchaka Jul 21, 2023

bedevere-bot removed the needs backport to 3.12 only security fixes label Jul 21, 2023

bedevere-bot removed the needs backport to 3.11 only security fixes label Jul 21, 2023

serhiy-storchaka added a commit that referenced this pull request Jul 21, 2023

[3.12] gh-106919: Use role :c:macro: for referencing the C "constants" (

ac9aa8a

GH-106920) (GH-106951) (cherry picked from commit fcc816d)

serhiy-storchaka added a commit that referenced this pull request Jul 21, 2023

[3.11] gh-106919: Use role :c:macro: for referencing the C "constants" (

6bde1b9

GH-106920) (GH-106952) (cherry picked from commit fcc816d)

serhiy-storchaka removed their assignment Jul 25, 2023

	platform's :c:macro:`LONG_MAX`) however no proper range checking is done --- the
	platform's :c:macro:`!LONG_MAX`) however no proper range checking is done --- the

Uh oh!

Uh oh!

Conversation

serhiy-storchaka commented Jul 20, 2023 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

erlend-aasland Jul 20, 2023

Choose a reason for hiding this comment

Uh oh!

serhiy-storchaka Jul 21, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

erlend-aasland left a comment

Choose a reason for hiding this comment

Uh oh!

ezio-melotti left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

miss-islington commented Jul 21, 2023

Uh oh!

miss-islington commented Jul 21, 2023

Uh oh!

miss-islington commented Jul 21, 2023

Uh oh!

bedevere-bot commented Jul 21, 2023

Uh oh!

bedevere-bot commented Jul 21, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

serhiy-storchaka commented Jul 20, 2023 •

edited by github-actions Bot

Loading