GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-85417: Clarify behaviour on branch cuts in cmath module by mdickinson · Pull Request #102046 · python/cpython

Conversation

@mdickinson

@mdickinson mdickinson commented Feb 19, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

This PR updates the cmath module documentation to reflect the reality that Python is almost always (and as far as I can tell, that "almost" can be omitted) running on a machine whose C double supports signed zeros.

  • Removes misleading references to functions being continuous from above / below / the left / the right at branch cuts
  • Expands the note on branch cuts at the top of the module to explain the double-sided sign-of-zero-based behaviour

Closes #85417

  • Issue: cmath module documentation is misleading on branch cuts #85417

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@mdickinson
pythongh-85417: Clarify behaviour on branch cuts in cmath module
ed5c0a5
@bedevere-bot bedevere-bot added the awaiting core review label Feb 19, 2023
@bedevere-bot bedevere-bot mentioned this pull request Feb 19, 2023
cmath module documentation is misleading on branch cuts #85417
Closed
@bedevere-bot bedevere-bot added the docs Documentation in the Doc dir label Feb 19, 2023
mdickinson
mdickinson commented Feb 19, 2023
View reviewed changes
Comment thread Doc/library/cmath.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

@skirpichev

skirpichev commented Feb 19, 2023

Copy link
Copy Markdown
Member

#102047 is more or less same, but less verbose.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

rhettinger
rhettinger approved these changes Feb 19, 2023
View reviewed changes
@bedevere-bot bedevere-bot added awaiting merge and removed awaiting core review labels Feb 19, 2023
CuriousLearner
CuriousLearner approved these changes Feb 19, 2023
View reviewed changes
@mdickinson
Grammar tweak: remove unnecessary comma
8d272e2
mdickinson
mdickinson commented Feb 19, 2023
View reviewed changes
Comment thread Doc/library/cmath.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

@mdickinson
Remove another comma for better flow
621fb2c
@mdickinson
mdickinson merged commit b513c46 into python:main Feb 19, 2023
@bedevere-bot bedevere-bot removed the awaiting merge label Feb 19, 2023
@mdickinson
mdickinson deleted the gh-85417-fix-cmath-branch-cut-documentation branch February 19, 2023 19:15
jaraco pushed a commit to jaraco/cpython that referenced this pull request Feb 20, 2023
@mdickinson @jaraco
pythongh-85417: Clarify behaviour on branch cuts in cmath module (pyt…
3c6360e
…hon#102046)

This PR updates the cmath module documentation to reflect the reality that Python is almost always (and as far as I can tell, that "almost" can be omitted) running on a machine whose C double supports signed zeros.

* Removes misleading references to functions being continuous from above / below / the left / the right at branch cuts
* Expands the note on branch cuts at the top of the module documentation to explain the double-sided sign-of-zero-based behaviour
@jaraco jaraco mentioned this pull request Feb 20, 2023
gh-88233: zipfile: refactor _strip_extra #102083
Closed
carljm added a commit to carljm/cpython that referenced this pull request Feb 20, 2023
@carljm
Merge branch 'main' into inlinecomp2
9f0fc5b
* main: (60 commits)
  pythongh-102056: Fix a few bugs in error handling of exception printing code (python#102078)
  pythongh-102011: use sys.exception() instead of sys.exc_info() in docs where possible (python#102012)
  pythongh-101566: Sync with zipp 3.14. (pythonGH-102018)
  pythonGH-99818: improve the documentation for zipfile.Path and Traversable (pythonGH-101589)
  pythongh-88233: zipfile: handle extras after a zip64 extra (pythonGH-96161)
  pythongh-101981: Apply HOMEBREW related environment variables (pythongh-102074)
  pythongh-101907: Stop using `_Py_OPCODE` and `_Py_OPARG` macros (pythonGH-101912)
  pythongh-101819: Adapt _io types to heap types, batch 1 (pythonGH-101949)
  pythongh-101981: Build macOS as recommended by the devguide (pythonGH-102070)
  pythongh-97786: Fix compiler warnings in pytime.c (python#101826)
  pythongh-101578: Amend PyErr_{Set,Get}RaisedException docs (python#101962)
  Misc improvements to the float tutorial (pythonGH-102052)
  pythongh-85417: Clarify behaviour on branch cuts in cmath module (python#102046)
  pythongh-100425: Update tutorial docs related to sum() accuracy (FH-101854)
  Add missing 'is' to `cmath.log()` docstring (python#102049)
  pythongh-100210: Correct the comment link for unescaping HTML (python#100212)
  pythongh-97930: Also include subdirectory in makefile. (python#102030)
  pythongh-99735: Use required=True in argparse subparsers example (python#100927)
  Fix incorrectly documented attribute in csv docs (python#101250)
  pythonGH-84783: Make the slice object hashable (pythonGH-101264)
  ...
@skirpichev skirpichev mentioned this pull request Feb 21, 2023
Few coverage nitpicks for the cmath module #102067
Merged
carljm added a commit to carljm/cpython that referenced this pull request Feb 22, 2023
@carljm
Merge branch 'main' into inlinecomp
544b30c
* main: (225 commits)
  pythongh-102056: Fix a few bugs in error handling of exception printing code (python#102078)
  pythongh-102011: use sys.exception() instead of sys.exc_info() in docs where possible (python#102012)
  pythongh-101566: Sync with zipp 3.14. (pythonGH-102018)
  pythonGH-99818: improve the documentation for zipfile.Path and Traversable (pythonGH-101589)
  pythongh-88233: zipfile: handle extras after a zip64 extra (pythonGH-96161)
  pythongh-101981: Apply HOMEBREW related environment variables (pythongh-102074)
  pythongh-101907: Stop using `_Py_OPCODE` and `_Py_OPARG` macros (pythonGH-101912)
  pythongh-101819: Adapt _io types to heap types, batch 1 (pythonGH-101949)
  pythongh-101981: Build macOS as recommended by the devguide (pythonGH-102070)
  pythongh-97786: Fix compiler warnings in pytime.c (python#101826)
  pythongh-101578: Amend PyErr_{Set,Get}RaisedException docs (python#101962)
  Misc improvements to the float tutorial (pythonGH-102052)
  pythongh-85417: Clarify behaviour on branch cuts in cmath module (python#102046)
  pythongh-100425: Update tutorial docs related to sum() accuracy (FH-101854)
  Add missing 'is' to `cmath.log()` docstring (python#102049)
  pythongh-100210: Correct the comment link for unescaping HTML (python#100212)
  pythongh-97930: Also include subdirectory in makefile. (python#102030)
  pythongh-99735: Use required=True in argparse subparsers example (python#100927)
  Fix incorrectly documented attribute in csv docs (python#101250)
  pythonGH-84783: Make the slice object hashable (pythonGH-101264)
  ...
@mdickinson mdickinson added needs backport to 3.10 needs backport to 3.11 only security fixes labels Feb 26, 2023
@miss-islington

miss-islington commented Feb 26, 2023

Copy link
Copy Markdown
Contributor

Thanks @mdickinson for the PR 🌮🎉.. I'm working now to backport this PR to: 3.10.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@miss-islington

miss-islington commented Feb 26, 2023

Copy link
Copy Markdown
Contributor

Thanks @mdickinson for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 26, 2023
@mdickinson @miss-islington
pythongh-85417: Clarify behaviour on branch cuts in cmath module (pyt…
03491ad
…honGH-102046)

This PR updates the cmath module documentation to reflect the reality that Python is almost always (and as far as I can tell, that "almost" can be omitted) running on a machine whose C double supports signed zeros.

* Removes misleading references to functions being continuous from above / below / the left / the right at branch cuts
* Expands the note on branch cuts at the top of the module documentation to explain the double-sided sign-of-zero-based behaviour
(cherry picked from commit b513c46)

Co-authored-by: Mark Dickinson <[email protected]>
@bedevere-bot

bedevere-bot commented Feb 26, 2023

Copy link
Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 label Feb 26, 2023
@bedevere-bot

bedevere-bot commented Feb 26, 2023

Copy link
Copy Markdown

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 26, 2023
@mdickinson @miss-islington
pythongh-85417: Clarify behaviour on branch cuts in cmath module (pyt…
c95dd17
…honGH-102046)

This PR updates the cmath module documentation to reflect the reality that Python is almost always (and as far as I can tell, that "almost" can be omitted) running on a machine whose C double supports signed zeros.

* Removes misleading references to functions being continuous from above / below / the left / the right at branch cuts
* Expands the note on branch cuts at the top of the module documentation to explain the double-sided sign-of-zero-based behaviour
(cherry picked from commit b513c46)

Co-authored-by: Mark Dickinson <[email protected]>
@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Feb 26, 2023
mdickinson added a commit that referenced this pull request Feb 26, 2023
@miss-islington @mdickinson
[3.10] gh-85417: Clarify behaviour on branch cuts in cmath module (GH…
601c9db
…-102046) (#102275)

gh-85417: Clarify behaviour on branch cuts in cmath module (GH-102046)

This PR updates the cmath module documentation to reflect the reality that Python is almost always (and as far as I can tell, that "almost" can be omitted) running on a machine whose C double supports signed zeros.

* Removes misleading references to functions being continuous from above / below / the left / the right at branch cuts
* Expands the note on branch cuts at the top of the module documentation to explain the double-sided sign-of-zero-based behaviour
(cherry picked from commit b513c46)

Co-authored-by: Mark Dickinson <[email protected]>
mdickinson added a commit that referenced this pull request Feb 26, 2023
@miss-islington @mdickinson
[3.11] gh-85417: Clarify behaviour on branch cuts in cmath module (GH…
626f471
…-102046) (#102276)

gh-85417: Clarify behaviour on branch cuts in cmath module (GH-102046)

This PR updates the cmath module documentation to reflect the reality that Python is almost always (and as far as I can tell, that "almost" can be omitted) running on a machine whose C double supports signed zeros.

* Removes misleading references to functions being continuous from above / below / the left / the right at branch cuts
* Expands the note on branch cuts at the top of the module documentation to explain the double-sided sign-of-zero-based behaviour
(cherry picked from commit b513c46)

Co-authored-by: Mark Dickinson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rhettinger rhettinger rhettinger approved these changes
@CuriousLearner CuriousLearner CuriousLearner approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs Documentation in the Doc dir

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

cmath module documentation is misleading on branch cuts

Uh oh!

There was an error while loading. Please reload this page.

6 participants

@mdickinson @skirpichev @miss-islington @bedevere-bot @rhettinger @CuriousLearner
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.