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.

Sign up for GitHub

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

Jump to bottom

gh-110383: Clarify "non-integral" wording in pow() docs #119688

Merged
merged 6 commits into from
Jun 7, 2024
Merged

gh-110383: Clarify "non-integral" wording in pow() docs #119688

merged 6 commits into from
Jun 7, 2024

Conversation

adiaholic
Copy link
Contributor

@adiaholic adiaholic commented May 28, 2024 •
edited by bedevere-app bot
Loading

This PR is a fix for an issue listed in #110383.

Use widely used non-integer instead of non-integral.
While both terms can be used to mean the same thing, "non-integer number" is the more precise and commonly used term. "Non-integral number" might sometimes be used in a broader sense in certain mathematical contexts, but it generally carries the same meaning as "non-integer number" when referring to real numbers.

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels May 28, 2024
@adiaholic adiaholic changed the title Pow() documentation - Use widely used non-integer instead of non-integral Adress two issues in #110383 May 28, 2024
@adiaholic adiaholic changed the title Adress two issues in #110383 Address two issues in #110383 May 28, 2024
@adiaholic adiaholic changed the title Address two issues in #110383 Address two issues from docs@python.org May 28, 2024
@davidlowryduda
Copy link
Contributor

You should rename this to have the issue number in the description. For example, calling it gh-110383: Address two issues from docs@python.org would better fit the naming convention.

@erlend-aasland erlend-aasland changed the title Address two issues from docs@python.org gh-110383: Address two issues from docs@python.org May 29, 2024
@bedevere-app bedevere-app bot mentioned this pull request May 29, 2024
Closed
@erlend-aasland
Copy link
Contributor

Thanks for the PR! It is preferable to fix only one issue per PR; even one-liners. This is because different changes may have different backporting needs.

@adiaholic adiaholic changed the title gh-110383: Address two issues from docs@python.org gh-110383: Pow - Use widely used non-integer instead of non-integral May 29, 2024
@erlend-aasland erlend-aasland changed the title gh-110383: Pow - Use widely used non-integer instead of non-integral gh-110383: Clarify "non-integral" wording in pow() docs May 30, 2024
@adiaholic adiaholic requested a review from erlend-aasland June 4, 2024 18:18
adiaholic added 4 commits June 4, 2024 12:32
@adiaholic
Use widely used non-integer instead of non-integral
f31e589 
While both terms can be used to mean the same thing, "non-integer number" is the
more precise and commonly used term. "Non-integral number" might sometimes be used
in a broader sense in certain mathematical contexts, but it generally carries the
same meaning as "non-integer number" when referring to real numbers.
@adiaholic
Correct documentation for signed and unsigned int in an array
d5dd0d7
@adiaholic
Revert changes in arrays.rst
7e42106
@adiaholic
Add helpful example
9419179
erlend-aasland
erlend-aasland approved these changes Jun 4, 2024
View reviewed changes
Copy link
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.

Apart from the leading whitespace in L1565 (IIRC), this looks like an improvement to me. I'll wait for @mdickinson's thumbs up before landing, though.

Thanks!

@erlend-aasland erlend-aasland added needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes labels Jun 4, 2024
@erlend-aasland
Copy link
Contributor

ISTM Mark's remark has been addressed; I'll merge this later today :)

@mdickinson
Copy link
Member

ISTM Mark's remark has been addressed

Addressed indeed! Thank you.

@erlend-aasland erlend-aasland merged commit 6646a9d into python:main Jun 7, 2024
25 checks passed
@miss-islington-app
Copy link

Thanks @adiaholic for the PR, and @erlend-aasland for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 7, 2024
@adiaholic @miss-islington
pythongh-110383: Clarify "non-integral" wording in pow() docs (python…
250ca53 
…GH-119688)

(cherry picked from commit 6646a9d)

Co-authored-by: Aditya Borikar <adityaborikar2@gmail.com>
@bedevere-app
Copy link

bedevere-app bot commented Jun 7, 2024

GH-120206 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jun 7, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 7, 2024
@adiaholic @miss-islington
pythongh-110383: Clarify "non-integral" wording in pow() docs (python…
ed49580 
…GH-119688)

(cherry picked from commit 6646a9d)

Co-authored-by: Aditya Borikar <adityaborikar2@gmail.com>
@bedevere-app
Copy link

bedevere-app bot commented Jun 7, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Jun 7, 2024
@erlend-aasland
Copy link
Contributor

A big thanks to everyone involved :)

erlend-aasland pushed a commit that referenced this pull request Jun 7, 2024
@miss-islington @adiaholic
[3.12] gh-110383: Clarify "non-integral" wording in pow() docs (GH-11…
501cd99 
…9688) (#120207)

(cherry picked from commit 6646a9d)

Co-authored-by: Aditya Borikar <adityaborikar2@gmail.com>
erlend-aasland pushed a commit that referenced this pull request Jun 7, 2024
@miss-islington @adiaholic
[3.13] gh-110383: Clarify "non-integral" wording in pow() docs (GH-11…
ffa7d82 
…9688) (#120206)

(cherry picked from commit 6646a9d)

Co-authored-by: Aditya Borikar <adityaborikar2@gmail.com>
noahbkim pushed a commit to hudson-trading/cpython that referenced this pull request Jul 11, 2024
@adiaholic @noahbkim
pythongh-110383: Clarify "non-integral" wording in pow() docs (python…
7f9bf8f 
…#119688)
estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024
@adiaholic @estyxx
pythongh-110383: Clarify "non-integral" wording in pow() docs (python…
1242c53 
…#119688)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@davidlowryduda davidlowryduda davidlowryduda left review comments

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

@mdickinson mdickinson mdickinson approved these changes

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.
4 participants
@adiaholic @davidlowryduda @erlend-aasland @mdickinson