Skip to content

GH-104145: Use fully-qualified cross reference types for the bisect module #104172

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom
Merged
merged 4 commits into from
May 8, 2023
Merged

GH-104145: Use fully-qualified cross reference types for the bisect module #104172

merged 4 commits into from
May 8, 2023

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented May 4, 2023 •
edited by github-actions bot
Loading

See #104145 (comment) for rationale, this fixes the cross-references to work properly. The alternate quick fix would be to use :func:`~bisect.bisect`.

A

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

@AA-Turner AA-Turner added docs Documentation in the Doc dir skip news needs backport to 3.11 only security fixes labels May 4, 2023
@AA-Turner AA-Turner requested a review from rhettinger as a code owner May 4, 2023 14:28
@AA-Turner AA-Turner self-assigned this May 4, 2023
@bedevere-bot bedevere-bot mentioned this pull request May 4, 2023
Closed
AlexWaygood
AlexWaygood reviewed May 4, 2023
View reviewed changes
@AlexWaygood
Copy link
Member

The alternate quick fix would be to use :func:`~bisect.bisect`

Oh, I think I might prefer that actually? I think I've seen that syntax more often in the CPython docs. The . in .bisect is also quite easy to miss (and might look like a mistake to non-Sphinx-experts)

@AA-Turner
Copy link
Member Author

Oh, I think I might prefer that actually?

Altered to this form in the latest push.

A

@AA-Turner AA-Turner changed the title GH-104145: Use 'refspecific' cross reference type for the bisect function GH-104145: Use fully-qualified cross reference types for the bisect module May 5, 2023
@rhettinger rhettinger removed their request for review May 5, 2023 14:32
AlexWaygood
AlexWaygood reviewed May 6, 2023
View reviewed changes
AlexWaygood
AlexWaygood approved these changes May 8, 2023
View reviewed changes
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

LGTM

AlexWaygood
AlexWaygood reviewed May 8, 2023
View reviewed changes
@AlexWaygood AlexWaygood merged commit 76eef55 into python:main May 8, 2023
@miss-islington
Copy link
Contributor

Thanks @AA-Turner for the PR, and @AlexWaygood for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

@AlexWaygood
Copy link
Member

Thank you!

@bedevere-bot
Copy link

GH-104295 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 May 8, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 8, 2023
@AA-Turner @miss-islington
pythonGH-104145: Use fully-qualified cross reference types for the bi…
3e5613c 
…sect module (pythonGH-104172)

(cherry picked from commit 76eef55)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
AlexWaygood pushed a commit that referenced this pull request May 8, 2023
@miss-islington @AA-Turner
[3.11] GH-104145: Use fully-qualified cross reference types for the b…
8a6ff59 
…isect module (GH-104172) (#104295)

GH-104145: Use fully-qualified cross reference types for the bisect module (GH-104172)
(cherry picked from commit 76eef55)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
jbower-fb pushed a commit to jbower-fb/cpython that referenced this pull request May 8, 2023
@AA-Turner @jbower-fb
pythonGH-104145: Use fully-qualified cross reference types for the bi…
a7e9a63 
…sect module (python#104172)
carljm added a commit to carljm/cpython that referenced this pull request May 9, 2023
@carljm
Merge branch 'main' into inlinecomp2
76077cd 
* main: (47 commits)
  pythongh-97696 Remove unnecessary check for eager_start kwarg (python#104188)
  pythonGH-104308: socket.getnameinfo should release the GIL (python#104307)
  pythongh-104310: Add importlib.util.allowing_all_extensions() (pythongh-104311)
  pythongh-99113: A Per-Interpreter GIL! (pythongh-104210)
  pythonGH-104284: Fix documentation gettext build (python#104296)
  pythongh-89550: Buffer GzipFile.write to reduce execution time by ~15% (python#101251)
  pythongh-104223: Fix issues with inheriting from buffer classes (python#104227)
  pythongh-99108: fix typo in Modules/Setup (python#104293)
  pythonGH-104145: Use fully-qualified cross reference types for the bisect module (python#104172)
  pythongh-103193: Improve `getattr_static` test coverage (python#104286)
  Trim trailing whitespace and test on CI (python#104275)
  pythongh-102500: Remove mention of bytes shorthand (python#104281)
  pythongh-97696: Improve and fix documentation for asyncio eager tasks (python#104256)
  pythongh-99108: Replace SHA3 implementation HACL* version (python#103597)
  pythongh-104273: Remove redundant len() calls in argparse function (python#104274)
  pythongh-64660: Don't hardcode Argument Clinic return converter result variable name (python#104200)
  pythongh-104265 Disallow instantiation of `_csv.Reader` and `_csv.Writer` (python#104266)
  pythonGH-102613: Improve performance of `pathlib.Path.rglob()` (pythonGH-104244)
  pythongh-103650: Fix perf maps address format (python#103651)
  pythonGH-89812: Churn `pathlib.Path` methods (pythonGH-104243)
  ...
carljm added a commit to carljm/cpython that referenced this pull request May 9, 2023
@carljm
Merge branch 'main' into fixsendfamily
a614216 
* main: (29 commits)
  pythongh-104276: Make `_struct.unpack_iterator` type use type flag instead of custom constructor (python#104277)
  pythongh-97696: Move around and update the whatsnew entry for asyncio eager task factory (python#104298)
  pythongh-103193: Fix refleaks in `test_inspect` and `test_typing` (python#104320)
  require-pr-label.yml: Add missing "permissions:" (python#104309)
  pythongh-90656: Add platform triplets for 64-bit LoongArch (LA64) (python#30939)
  pythongh-104180: Read SOCKS proxies from macOS System Configuration (python#104181)
  pythongh-97696 Remove unnecessary check for eager_start kwarg (python#104188)
  pythonGH-104308: socket.getnameinfo should release the GIL (python#104307)
  pythongh-104310: Add importlib.util.allowing_all_extensions() (pythongh-104311)
  pythongh-99113: A Per-Interpreter GIL! (pythongh-104210)
  pythonGH-104284: Fix documentation gettext build (python#104296)
  pythongh-89550: Buffer GzipFile.write to reduce execution time by ~15% (python#101251)
  pythongh-104223: Fix issues with inheriting from buffer classes (python#104227)
  pythongh-99108: fix typo in Modules/Setup (python#104293)
  pythonGH-104145: Use fully-qualified cross reference types for the bisect module (python#104172)
  pythongh-103193: Improve `getattr_static` test coverage (python#104286)
  Trim trailing whitespace and test on CI (python#104275)
  pythongh-102500: Remove mention of bytes shorthand (python#104281)
  pythongh-97696: Improve and fix documentation for asyncio eager tasks (python#104256)
  pythongh-99108: Replace SHA3 implementation HACL* version (python#103597)
  ...
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@AlexWaygood AlexWaygood AlexWaygood approved these changes

Assignees

@AA-Turner AA-Turner

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
@AA-Turner @AlexWaygood @miss-islington @bedevere-bot