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-101100: Fix sphinx warnings in `types` module by sobolevn · Pull Request #102274 · python/cpython

Conversation

@sobolevn

@sobolevn sobolevn commented Feb 26, 2023 •
edited by bedevere-bot
Loading

Uh oh!

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

Copy link
Copy Markdown
Member

We had a Sphinx warning in types.rst module:

./cpython/Doc/library/types.rst:484: WARNING: py:meth reference target not found: __await__

This is the only warning we had for this module.

I've done a small research: whether it is __await__ or

``__await__``

It looks like the first case is slightly more popular. Example: https://github.com/python/cpython/blame/main/Doc/library/types.rst#L466

  • Issue: Fix all Sphinx reference warnings in the documentation #101100

Sorry, something went wrong.

Uh oh!

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

All reactions
@sobolevn
pythongh-101100: Fix sphinx warnings in types module
7fc7361
@sobolevn
sobolevn requested a review from AlexWaygood February 26, 2023 08:52
@bedevere-bot bedevere-bot added the awaiting review label Feb 26, 2023
@bedevere-bot bedevere-bot mentioned this pull request Feb 26, 2023
Fix all Sphinx reference warnings in the documentation #101100
Closed
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir skip news labels Feb 26, 2023
AlexWaygood
AlexWaygood reviewed Feb 26, 2023
View reviewed changes
Comment thread Doc/library/types.rst Resolved

Uh oh!

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

@sobolevn @AlexWaygood
Update Doc/library/types.rst
84d0398
Co-authored-by: Alex Waygood <[email protected]>
AlexWaygood
AlexWaygood approved these changes Feb 27, 2023
View reviewed changes
@bedevere-bot bedevere-bot added awaiting merge and removed awaiting review labels Feb 27, 2023
@AlexWaygood AlexWaygood added needs backport to 3.10 needs backport to 3.11 only security fixes labels Feb 27, 2023
@AlexWaygood
AlexWaygood merged commit 101a12c into python:main Feb 27, 2023
@miss-islington

miss-islington commented Feb 27, 2023

Copy link
Copy Markdown
Contributor

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

All reactions

Sorry, something went wrong.

Uh oh!

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

@bedevere-bot bedevere-bot removed the awaiting merge label Feb 27, 2023
@bedevere-bot

bedevere-bot commented Feb 27, 2023

Copy link
Copy Markdown

GH-102291 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.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Feb 27, 2023
@bedevere-bot

bedevere-bot commented Feb 27, 2023

Copy link
Copy Markdown

GH-102292 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.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 27, 2023
@sobolevn @AlexWaygood @miss-islington
pythongh-101100: Fix sphinx warnings in types module (pythonGH-102274)
8029764
(cherry picked from commit 101a12c)

Co-authored-by: Nikita Sobolev <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 27, 2023
@sobolevn @AlexWaygood @miss-islington
pythongh-101100: Fix sphinx warnings in types module (pythonGH-102274)
aed79b5
(cherry picked from commit 101a12c)

Co-authored-by: Nikita Sobolev <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
@bedevere-bot bedevere-bot removed the needs backport to 3.10 label Feb 27, 2023
miss-islington added a commit that referenced this pull request Feb 27, 2023
@miss-islington @sobolevn @AlexWaygood
gh-101100: Fix sphinx warnings in types module (GH-102274)
bd4a709
(cherry picked from commit 101a12c)

Co-authored-by: Nikita Sobolev <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
miss-islington added a commit that referenced this pull request Feb 27, 2023
@miss-islington @sobolevn @AlexWaygood
gh-101100: Fix sphinx warnings in types module (GH-102274)
cba52ec
(cherry picked from commit 101a12c)

Co-authored-by: Nikita Sobolev <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
carljm added a commit to carljm/cpython that referenced this pull request Feb 28, 2023
@carljm
Merge branch 'main' into inlinecomp2
73dc0ed
* main: (67 commits)
  pythongh-99108: Add missing md5/sha1 defines to Modules/Setup (python#102308)
  pythongh-100227: Move _str_replace_inf to PyInterpreterState (pythongh-102333)
  pythongh-100227: Move the dtoa State to PyInterpreterState (pythongh-102331)
  pythonGH-102305: Expand some macros in generated_cases.c.h (python#102309)
  Migrate to new PSF mailgun account (python#102284)
  pythongh-102192: Replace PyErr_Fetch/Restore etc by more efficient alternatives (in Python/) (python#102193)
  pythonGH-90744: Fix erroneous doc links in the sys module (python#101319)
  pythongh-87092: Make jump target label equal to the offset of the target in the instructions sequence (python#102093)
  pythongh-101101: Unstable C API tier (PEP 689) (pythonGH-101102)
  IDLE: Simplify DynOptionsMenu __init__code (python#101371)
  pythongh-101561: Add typing.override decorator (python#101564)
  pythongh-101825: Clarify that as_integer_ratio() output is always normalized (python#101843)
  pythongh-101773: Optimize creation of Fractions in private methods (python#101780)
  pythongh-102251: Updates to test_imp Toward Fixing Some Refleaks (pythongh-102254)
  pythongh-102296 Document that inspect.Parameter kinds support ordering (pythonGH-102297)
  pythongh-102250: Fix double-decref in COMPARE_AND_BRANCH error case (pythonGH-102287)
  pythongh-101100: Fix sphinx warnings in `types` module (python#102274)
  pythongh-91038: Change default argument value to `False` instead of `0` (python#31621)
  pythongh-101765: unicodeobject: use Py_XDECREF correctly (python#102283)
  [doc] Improve grammar/fix missing word (pythonGH-102060)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AlexWaygood AlexWaygood AlexWaygood 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 skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

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

4 participants

@sobolevn @miss-islington @bedevere-bot @AlexWaygood
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.