Thanks to visit codestin.com
Credit goes to github.com

Skip to content

gh-106919: Use role :c:macro: for referencing the C "constants"#106920

Merged
serhiy-storchaka merged 4 commits intopython:mainfrom
serhiy-storchaka:docs-c-macro-roles
Jul 21, 2023
Merged

gh-106919: Use role :c:macro: for referencing the C "constants"#106920
serhiy-storchaka merged 4 commits intopython:mainfrom
serhiy-storchaka:docs-c-macro-roles

Conversation

@serhiy-storchaka
Copy link
Copy Markdown
Member

@serhiy-storchaka serhiy-storchaka commented Jul 20, 2023 •
edited by github-actions Bot
Loading

@bedevere-bot bedevere-bot mentioned this pull request Jul 20, 2023
Closed
@bedevere-bot bedevere-bot added awaiting core review docs Documentation in the Doc dir labels Jul 20, 2023
erlend-aasland
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
erlend-aasland
erlend-aasland reviewed Jul 20, 2023
View reviewed changes
Comment thread Doc/c-api/arg.rst

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
Copy link
Copy Markdown
Contributor

@erlend-aasland erlend-aasland Jul 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member Author

@serhiy-storchaka serhiy-storchaka Jul 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread Doc/c-api/call.rst
erlend-aasland
erlend-aasland approved these changes Jul 20, 2023
View reviewed changes
Copy link
Copy Markdown
Contributor

@erlend-aasland erlend-aasland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, with one nit. Thanks!

ezio-melotti
ezio-melotti approved these changes Jul 21, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@ezio-melotti ezio-melotti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Comment thread Doc/c-api/structures.rst Outdated
@serhiy-storchaka serhiy-storchaka merged commit fcc816d into python:main Jul 21, 2023
@miss-islington
Copy link
Copy Markdown
Contributor

miss-islington commented Jul 21, 2023

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

@serhiy-storchaka serhiy-storchaka deleted the docs-c-macro-roles branch July 21, 2023 07:52
@miss-islington
Copy link
Copy Markdown
Contributor

miss-islington commented Jul 21, 2023

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
Copy link
Copy Markdown
Contributor

miss-islington commented Jul 21, 2023

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

serhiy-storchaka added a commit to serhiy-storchaka/cpython that referenced this pull request Jul 21, 2023
@serhiy-storchaka
[3.12] pythongh-106919: Use role :c:macro: for referencing the C "con…
ae8937a 
…stants" (pythonGH-106920).

(cherry picked from commit fcc816d)

Co-authored-by: Serhiy Storchaka <[email protected]>
@bedevere-bot
Copy link
Copy Markdown

bedevere-bot commented Jul 21, 2023

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

@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label Jul 21, 2023
serhiy-storchaka added a commit to serhiy-storchaka/cpython that referenced this pull request Jul 21, 2023
@serhiy-storchaka
[3.11] pythongh-106919: Use role :c:macro: for referencing the C "con…
039e3fc 
…stants" (pythonGH-106920).

(cherry picked from commit fcc816d)

Co-authored-by: Serhiy Storchaka <[email protected]>
@bedevere-bot
Copy link
Copy Markdown

bedevere-bot commented Jul 21, 2023

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

@bedevere-bot 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
@serhiy-storchaka
[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
@serhiy-storchaka
[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 serhiy-storchaka removed their assignment Jul 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@erlend-aasland erlend-aasland erlend-aasland approved these changes

@ezio-melotti ezio-melotti ezio-melotti approved these changes

@vstinner vstinner Awaiting requested review from vstinner

@encukou encukou Awaiting requested review from encukou encukou is a code owner

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@serhiy-storchaka @miss-islington @bedevere-bot @erlend-aasland @ezio-melotti