René's URL Explorer Experiment


Title: Accommodate Sphinx option by changing docstring return type of "integer" to "int". · Issue #100989 · python/cpython · GitHub

Open Graph Title: Accommodate Sphinx option by changing docstring return type of "integer" to "int". · Issue #100989 · python/cpython

X Title: Accommodate Sphinx option by changing docstring return type of "integer" to "int". · Issue #100989 · python/cpython

Description: Bug report When collections.deque is subclassed and the resulting class is documented with Sphinx using the option :inherited-members:, the following error appears: WARNING: py:class reference target not found: integer -- return number o...

Open Graph Description: Bug report When collections.deque is subclassed and the resulting class is documented with Sphinx using the option :inherited-members:, the following error appears: WARNING: py:class reference targ...

X Description: Bug report When collections.deque is subclassed and the resulting class is documented with Sphinx using the option :inherited-members:, the following error appears: WARNING: py:class reference targ...

Opengraph URL: https://github.com/python/cpython/issues/100989

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Accommodate Sphinx option by changing docstring return type of \"integer\" to \"int\".","articleBody":"# Bug report\r\n\r\nWhen `collections.deque` is subclassed and the resulting class is documented with Sphinx using the option `:inherited-members:`, the following error appears:\r\n```\r\nWARNING: py:class reference target not found: integer -- return number of occurrences of value\r\n```\r\n\r\nI assume this is because the `PyDoc_STRVAR` docstring of the C-implementation is not compliant to [PEP-7](https://peps.python.org/pep-0007/#documentation-strings) as required in [`PyDoc_STRVAR`](https://docs.python.org/3/c-api/intro.html#c.PyDoc_STRVAR):\r\nhttps://github.com/python/cpython/blob/d9dff4c8b5ab41c47af002ad7fb083c953e75f31/Modules/_collectionsmodule.c#L992-L993\r\n\r\nAnd everything after `-\u003e` is interpreted as type hint.\r\n\r\nThis can be reproduced with e.g. a python module `sub_deque.py`:\r\n```\r\nclass SubDeque(deque):\r\n    pass\r\n```\r\nand a documenation file `docs/src/sub_deque.rst`:\r\n```\r\n.. automodule:: sub_deque\r\n   :inherited-members:\r\n```\r\nwhich is then built with Sphinx: `sphinx-build -W docs/src docs/dist`.\r\n\r\n\r\nI'd be happy to provide a patch for this myself if you feel this issue should be fixed.\r\n\r\n# Your environment\r\n\r\n\u003c!-- Include as many relevant details as possible about the environment you experienced the bug in --\u003e\r\n\r\n- CPython versions tested on: 3.7 - 3.11\r\n- Operating system and architecture: Arch Linux \u0026 Ubuntu\r\n\n\n\u003c!-- gh-linked-prs --\u003e\n### Linked PRs\n* gh-100990\n* gh-102910\n* gh-102911\n* gh-102949\n* gh-102979\n* gh-102984\n* gh-102985\n* gh-102991\n* gh-102992\n\u003c!-- /gh-linked-prs --\u003e\n","author":{"url":"https://github.com/timobrembeck","@type":"Person","name":"timobrembeck"},"datePublished":"2023-01-12T15:12:48.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":16},"url":"https://github.com/100989/cpython/issues/100989"}

route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:347a994a-62a2-f187-46e5-e6454dc92088
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idB432:31FE0A:1407FD2:1BF406A:696A4082
html-safe-noncec44b0c22c30a9b3699c18b705c1f91b4132a46ea84e7e8627fe4600ce3e0cbc5
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCNDMyOjMxRkUwQToxNDA3RkQyOjFCRjQwNkE6Njk2QTQwODIiLCJ2aXNpdG9yX2lkIjoiNjc1MTg5MDc2Mzc4MTEyODMyMiIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmac3a3ec17eb2bdd85ab1785ccf70fd91c148e0d0c35f32c964bd9ba6652826c82d
hovercard-subject-tagissue:1530887440
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python/cpython/100989/issue_layout
twitter:imagehttps://opengraph.githubassets.com/14bf8efe9a8811e973b8bcc422db4cf41258e69b8e18af87bd46857adbd5971b/python/cpython/issues/100989
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/14bf8efe9a8811e973b8bcc422db4cf41258e69b8e18af87bd46857adbd5971b/python/cpython/issues/100989
og:image:altBug report When collections.deque is subclassed and the resulting class is documented with Sphinx using the option :inherited-members:, the following error appears: WARNING: py:class reference targ...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernametimobrembeck
hostnamegithub.com
expected-hostnamegithub.com
None321736bfdb3f591415ae895a0459bec204b26a76caf47ba5c980634cfacc4538
turbo-cache-controlno-preview
go-importgithub.com/python/cpython git https://github.com/python/cpython.git
octolytics-dimension-user_id1525981
octolytics-dimension-user_loginpython
octolytics-dimension-repository_id81598961
octolytics-dimension-repository_nwopython/cpython
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id81598961
octolytics-dimension-repository_network_root_nwopython/cpython
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release13581a31d51edf4a3aca179e10890a4d4f9b6d76
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/python/cpython/issues/100989#start-of-content
https://github.com/
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fcpython%2Fissues%2F100989
GitHub CopilotWrite better code with AIhttps://github.com/features/copilot
GitHub SparkBuild and deploy intelligent appshttps://github.com/features/spark
GitHub ModelsManage and compare promptshttps://github.com/features/models
MCP RegistryNewIntegrate external toolshttps://github.com/mcp
ActionsAutomate any workflowhttps://github.com/features/actions
CodespacesInstant dev environmentshttps://github.com/features/codespaces
IssuesPlan and track workhttps://github.com/features/issues
Code ReviewManage code changeshttps://github.com/features/code-review
GitHub Advanced SecurityFind and fix vulnerabilitieshttps://github.com/security/advanced-security
Code securitySecure your code as you buildhttps://github.com/security/advanced-security/code-security
Secret protectionStop leaks before they starthttps://github.com/security/advanced-security/secret-protection
Why GitHubhttps://github.com/why-github
Documentationhttps://docs.github.com
Bloghttps://github.blog
Changeloghttps://github.blog/changelog
Marketplacehttps://github.com/marketplace
View all featureshttps://github.com/features
Enterpriseshttps://github.com/enterprise
Small and medium teamshttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
App Modernizationhttps://github.com/solutions/use-case/app-modernization
DevSecOpshttps://github.com/solutions/use-case/devsecops
DevOpshttps://github.com/solutions/use-case/devops
CI/CDhttps://github.com/solutions/use-case/ci-cd
View all use caseshttps://github.com/solutions/use-case
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
View all industrieshttps://github.com/solutions/industry
View all solutionshttps://github.com/solutions
AIhttps://github.com/resources/articles?topic=ai
Software Developmenthttps://github.com/resources/articles?topic=software-development
DevOpshttps://github.com/resources/articles?topic=devops
Securityhttps://github.com/resources/articles?topic=security
View all topicshttps://github.com/resources/articles
Customer storieshttps://github.com/customer-stories
Events & webinarshttps://github.com/resources/events
Ebooks & reportshttps://github.com/resources/whitepapers
Business insightshttps://github.com/solutions/executive-insights
GitHub Skillshttps://skills.github.com
Documentationhttps://docs.github.com
Customer supporthttps://support.github.com
Community forumhttps://github.com/orgs/community/discussions
Trust centerhttps://github.com/trust-center
Partnershttps://github.com/partners
GitHub SponsorsFund open source developershttps://github.com/sponsors
Security Labhttps://securitylab.github.com
Maintainer Communityhttps://maintainers.github.com
Acceleratorhttps://github.com/accelerator
Archive Programhttps://archiveprogram.github.com
Topicshttps://github.com/topics
Trendinghttps://github.com/trending
Collectionshttps://github.com/collections
Enterprise platformAI-powered developer platformhttps://github.com/enterprise
GitHub Advanced SecurityEnterprise-grade security featureshttps://github.com/security/advanced-security
Copilot for BusinessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/premium-support
Pricinghttps://github.com/pricing
Search syntax tipshttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
documentationhttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fcpython%2Fissues%2F100989
Sign up https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=python%2Fcpython
Reloadhttps://github.com/python/cpython/issues/100989
Reloadhttps://github.com/python/cpython/issues/100989
Reloadhttps://github.com/python/cpython/issues/100989
python https://github.com/python
cpythonhttps://github.com/python/cpython
Please reload this pagehttps://github.com/python/cpython/issues/100989
Notifications https://github.com/login?return_to=%2Fpython%2Fcpython
Fork 33.9k https://github.com/login?return_to=%2Fpython%2Fcpython
Star 71.1k https://github.com/login?return_to=%2Fpython%2Fcpython
Code https://github.com/python/cpython
Issues 5k+ https://github.com/python/cpython/issues
Pull requests 2.1k https://github.com/python/cpython/pulls
Actions https://github.com/python/cpython/actions
Projects 31 https://github.com/python/cpython/projects
Security Uh oh! There was an error while loading. Please reload this page. https://github.com/python/cpython/security
Please reload this pagehttps://github.com/python/cpython/issues/100989
Insights https://github.com/python/cpython/pulse
Code https://github.com/python/cpython
Issues https://github.com/python/cpython/issues
Pull requests https://github.com/python/cpython/pulls
Actions https://github.com/python/cpython/actions
Projects https://github.com/python/cpython/projects
Security https://github.com/python/cpython/security
Insights https://github.com/python/cpython/pulse
New issuehttps://github.com/login?return_to=https://github.com/python/cpython/issues/100989
New issuehttps://github.com/login?return_to=https://github.com/python/cpython/issues/100989
Accommodate Sphinx option by changing docstring return type of "integer" to "int".https://github.com/python/cpython/issues/100989#top
https://github.com/rhettinger
docsDocumentation in the Doc dirhttps://github.com/python/cpython/issues?q=state%3Aopen%20label%3A%22docs%22
extension-modulesC modules in the Modules dirhttps://github.com/python/cpython/issues?q=state%3Aopen%20label%3A%22extension-modules%22
https://github.com/timobrembeck
https://github.com/timobrembeck
timobrembeckhttps://github.com/timobrembeck
on Jan 12, 2023https://github.com/python/cpython/issues/100989#issue-1530887440
PEP-7https://peps.python.org/pep-0007/#documentation-strings
PyDoc_STRVARhttps://docs.python.org/3/c-api/intro.html#c.PyDoc_STRVAR
cpython/Modules/_collectionsmodule.chttps://github.com/python/cpython/blob/d9dff4c8b5ab41c47af002ad7fb083c953e75f31/Modules/_collectionsmodule.c#L992-L993
d9dff4chttps://github.com/python/cpython/commit/d9dff4c8b5ab41c47af002ad7fb083c953e75f31
gh-100989: Fix docstrings of collections.deque #100990https://github.com/python/cpython/pull/100990
[3.11] gh-100989: Improve the accuracy of collections.deque docstrings (GH-100990) #102910https://github.com/python/cpython/pull/102910
[3.10] gh-100989: Improve the accuracy of collections.deque docstrings (GH-100990) #102911https://github.com/python/cpython/pull/102911
gh-100989: Revert #100990: Improve the accuracy of collections.deque docstrings #102949https://github.com/python/cpython/pull/102949
GH-100989: Revert Improve the accuracy of collections.deque docstrings #102979https://github.com/python/cpython/pull/102979
[3.11] GH-100989: Revert Improve the accuracy of collections.deque docstrings (GH-102979) #102984https://github.com/python/cpython/pull/102984
[3.10] GH-100989: Revert Improve the accuracy of collections.deque docstrings (GH-102979) #102985https://github.com/python/cpython/pull/102985
GH-100989: remove annotation from docstring #102991https://github.com/python/cpython/pull/102991
[3.11] GH-100989: remove annotation from docstring (GH-102991) #102992https://github.com/python/cpython/pull/102992
rhettingerhttps://github.com/rhettinger
docsDocumentation in the Doc dirhttps://github.com/python/cpython/issues?q=state%3Aopen%20label%3A%22docs%22
extension-modulesC modules in the Modules dirhttps://github.com/python/cpython/issues?q=state%3Aopen%20label%3A%22extension-modules%22
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.