René's URL Explorer Experiment


Title: gh-101100: Fix Sphinx warnings in library/tarfile.rst by hugovk · Pull Request #113237 · python/cpython · GitHub

Open Graph Title: gh-101100: Fix Sphinx warnings in library/tarfile.rst by hugovk · Pull Request #113237 · python/cpython

X Title: gh-101100: Fix Sphinx warnings in library/tarfile.rst by hugovk · Pull Request #113237 · python/cpython

Description: Fix 23 warnings: ❯ SPHINXERRORHANDLING=-n PATH=./venv/bin:$PATH sphinx-build -b html -d buildDoctrees -j auto -n . build/html library/tarfile.rst 2>&1 | grep WARNING | tee >(wc -l) Doc/library/tarfile.rst:115: WARNING: py:meth reference target not found: read Doc/library/tarfile.rst:115: WARNING: py:meth reference target not found: write Doc/library/tarfile.rst:326: WARNING: py:attr reference target not found: name Doc/library/tarfile.rst:361: WARNING: py:attr reference target not found: ~TarFile.errorlevel Doc/library/tarfile.rst:648: WARNING: py:meth reference target not found: !TarFile.getmember Doc/library/tarfile.rst:648: WARNING: py:meth reference target not found: !TarFile.getmembers Doc/library/tarfile.rst:648: WARNING: py:meth reference target not found: TarInfo.replace Doc/library/tarfile.rst:730: WARNING: py:const reference target not found: REGTYPE Doc/library/tarfile.rst:730: WARNING: py:const reference target not found: AREGTYPE Doc/library/tarfile.rst:730: WARNING: py:const reference target not found: LNKTYPE Doc/library/tarfile.rst:730: WARNING: py:const reference target not found: SYMTYPE Doc/library/tarfile.rst:730: WARNING: py:const reference target not found: DIRTYPE Doc/library/tarfile.rst:730: WARNING: py:const reference target not found: FIFOTYPE Doc/library/tarfile.rst:730: WARNING: py:const reference target not found: CONTTYPE Doc/library/tarfile.rst:730: WARNING: py:const reference target not found: CHRTYPE Doc/library/tarfile.rst:730: WARNING: py:const reference target not found: BLKTYPE Doc/library/tarfile.rst:730: WARNING: py:const reference target not found: GNUTYPE_SPARSE Doc/library/tarfile.rst:740: WARNING: py:const reference target not found: LNKTYPE Doc/library/tarfile.rst:740: WARNING: py:const reference target not found: SYMTYPE Doc/library/tarfile.rst:819: WARNING: py:class reference target not found: Tarinfo Doc/library/tarfile.rst:954: WARNING: py:const reference target not found: stat.S_IWGRP`|:const:`~stat.S_IWOTH Doc/library/tarfile.rst:979: WARNING: py:const reference target not found: stat.S_IRUSR`|:const:`~stat.S_IWUSR Doc/library/tarfile.rst:981: WARNING: py:const reference target not found: stat.S_IXGRP`|:const:`~stat.S_IXOTH 23 Involved adding docs for a number of constants, based on the comments from the source: cpython/Lib/tarfile.py Lines 87 to 99 in cfa25fe REGTYPE = b"0" # regular file AREGTYPE = b"\0" # regular file LNKTYPE = b"1" # link (inside tarfile) SYMTYPE = b"2" # symbolic link CHRTYPE = b"3" # character special device BLKTYPE = b"4" # block special device DIRTYPE = b"5" # directory FIFOTYPE = b"6" # fifo special device CONTTYPE = b"7" # contiguous file GNUTYPE_LONGNAME = b"L" # GNU tar longname GNUTYPE_LONGLINK = b"K" # GNU tar longlink GNUTYPE_SPARSE = b"S" # GNU tar sparse file The order matches that in the source. GNUTYPE_SPARSE is referenced in the docs (and caused a warning), GNUTYPE_LONGNAME and GNUTYPE_LONGLINK are not; I added all three to docs. Issue: gh-101100 📚 Documentation preview 📚: https://cpython-previews--113237.org.readthedocs.build/en/113237/library/tarfile.html

Open Graph Description: Fix 23 warnings: ❯ SPHINXERRORHANDLING=-n PATH=./venv/bin:$PATH sphinx-build -b html -d buildDoctrees -j auto -n . build/html library/tarfile.rst 2>&1 | grep WARNING | tee >(wc -l) Doc/li...

X Description: Fix 23 warnings: ❯ SPHINXERRORHANDLING=-n PATH=./venv/bin:$PATH sphinx-build -b html -d buildDoctrees -j auto -n . build/html library/tarfile.rst 2>&1 | grep WARNING | tee >(w...

Opengraph URL: https://github.com/python/cpython/pull/113237

X: @github

direct link

Domain: github.com

route-pattern/:user_id/:repository/pull/:id/files(.:format)
route-controllerpull_requests
route-actionfiles
fetch-noncev2:b4945586-681c-392d-1a7e-0234fa91f2b2
current-catalog-service-hashae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b
request-idE098:148816:49CEB7:686B74:696A476E
html-safe-nonce1639dcf6a9e79faebeea8a70bae8db5a57c85bb5d06c2cd91643839368568b4e
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFMDk4OjE0ODgxNjo0OUNFQjc6Njg2Qjc0OjY5NkE0NzZFIiwidmlzaXRvcl9pZCI6IjM1NTg2NTE3MzU1MDU4MTYxNCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmac4d0beb061ab1b73e2227a186af485849fe80fedd9b3da1cee6f2429af889547b
hovercard-subject-tagpull_request:1647418122
github-keyboard-shortcutsrepository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///pull_requests/show/files
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/python/cpython/pull/113237/files
twitter:imagehttps://avatars.githubusercontent.com/u/1324225?s=400&v=4
twitter:cardsummary_large_image
og:imagehttps://avatars.githubusercontent.com/u/1324225?s=400&v=4
og:image:altFix 23 warnings: ❯ SPHINXERRORHANDLING=-n PATH=./venv/bin:$PATH sphinx-build -b html -d buildDoctrees -j auto -n . build/html library/tarfile.rst 2>&1 | grep WARNING | tee >(wc -l) Doc/li...
og:site_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
None3f871c8e07f0ae1886fa8dac284166d28b09ad5bada6476fc10b674e489788ef
turbo-cache-controlno-preview
diff-viewunified
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 full-width
disable-turbotrue
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release63c426b30d262aba269ef14c40e3c817b384cd61
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/python/cpython/pull/113237/files#start-of-content
https://github.com/
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fcpython%2Fpull%2F113237%2Ffiles
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%2Fpull%2F113237%2Ffiles
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%2Fpull_requests%2Fshow%2Ffiles&source=header-repo&source_repo=python%2Fcpython
Reloadhttps://github.com/python/cpython/pull/113237/files
Reloadhttps://github.com/python/cpython/pull/113237/files
Reloadhttps://github.com/python/cpython/pull/113237/files
python https://github.com/python
cpythonhttps://github.com/python/cpython
Please reload this pagehttps://github.com/python/cpython/pull/113237/files
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/pull/113237/files
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
Sign up for GitHub https://github.com/signup?return_to=%2Fpython%2Fcpython%2Fissues%2Fnew%2Fchoose
terms of servicehttps://docs.github.com/terms
privacy statementhttps://docs.github.com/privacy
Sign inhttps://github.com/login?return_to=%2Fpython%2Fcpython%2Fissues%2Fnew%2Fchoose
hugovkhttps://github.com/hugovk
python:mainhttps://github.com/python/cpython/tree/main
hugovk:docs-fix-sphinx-warnings-tarfilehttps://github.com/hugovk/cpython/tree/docs-fix-sphinx-warnings-tarfile
Conversation 8 https://github.com/python/cpython/pull/113237
Commits 1 https://github.com/python/cpython/pull/113237/commits
Checks 0 https://github.com/python/cpython/pull/113237/checks
Files changed https://github.com/python/cpython/pull/113237/files
Please reload this pagehttps://github.com/python/cpython/pull/113237/files
gh-101100: Fix Sphinx warnings in library/tarfile.rst https://github.com/python/cpython/pull/113237/files#top
Show all changes 1 commit https://github.com/python/cpython/pull/113237/files
fbcf959 Fix Sphinx warnings in library/tarfile.rst hugovk Dec 17, 2023 https://github.com/python/cpython/pull/113237/commits/fbcf9598a4d859ce604deccdaea7d345197f7266
Clear filters https://github.com/python/cpython/pull/113237/files
Please reload this pagehttps://github.com/python/cpython/pull/113237/files
Please reload this pagehttps://github.com/python/cpython/pull/113237/files
tarfile.rst https://github.com/python/cpython/pull/113237/files#diff-130eff7d2ababf1fb3d3b179e70d48e4c3ad8f7dc32d15a5267fde82a664928c
.nitignore https://github.com/python/cpython/pull/113237/files#diff-b7c84835b887ce2fbbbbdbfb8aaee3317c5b731ed4c6c4682e122de334984c9c
https://github.com/python/cpython/blob/main/.github/CODEOWNERS#L588
Doc/library/tarfile.rsthttps://github.com/python/cpython/pull/113237/files#diff-130eff7d2ababf1fb3d3b179e70d48e4c3ad8f7dc32d15a5267fde82a664928c
View file https://github.com/hugovk/cpython/blob/fbcf9598a4d859ce604deccdaea7d345197f7266/Doc/library/tarfile.rst
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python/cpython/pull/113237/{{ revealButtonHref }}
https://github.com/python/cpython/pull/113237/files#diff-130eff7d2ababf1fb3d3b179e70d48e4c3ad8f7dc32d15a5267fde82a664928c
https://github.com/python/cpython/pull/113237/files#diff-130eff7d2ababf1fb3d3b179e70d48e4c3ad8f7dc32d15a5267fde82a664928c
https://github.com/python/cpython/pull/113237/files#diff-130eff7d2ababf1fb3d3b179e70d48e4c3ad8f7dc32d15a5267fde82a664928c
https://github.com/python/cpython/pull/113237/files#diff-130eff7d2ababf1fb3d3b179e70d48e4c3ad8f7dc32d15a5267fde82a664928c
https://github.com/python/cpython/pull/113237/files#diff-130eff7d2ababf1fb3d3b179e70d48e4c3ad8f7dc32d15a5267fde82a664928c
https://github.com/python/cpython/pull/113237/files#diff-130eff7d2ababf1fb3d3b179e70d48e4c3ad8f7dc32d15a5267fde82a664928c
https://github.com/python/cpython/pull/113237/files#diff-130eff7d2ababf1fb3d3b179e70d48e4c3ad8f7dc32d15a5267fde82a664928c
https://github.com/python/cpython/pull/113237/files#diff-130eff7d2ababf1fb3d3b179e70d48e4c3ad8f7dc32d15a5267fde82a664928c
https://github.com/python/cpython/pull/113237/files#diff-130eff7d2ababf1fb3d3b179e70d48e4c3ad8f7dc32d15a5267fde82a664928c
https://github.com/python/cpython/pull/113237/files#diff-130eff7d2ababf1fb3d3b179e70d48e4c3ad8f7dc32d15a5267fde82a664928c
https://github.com/python/cpython/pull/113237/files#diff-130eff7d2ababf1fb3d3b179e70d48e4c3ad8f7dc32d15a5267fde82a664928c
willingchttps://github.com/willingc
Dec 17, 2023https://github.com/python/cpython/pull/113237/files#r1429247636
Learn morehttps://docs.github.com/articles/managing-disruptive-comments/#hiding-a-comment
Please reload this pagehttps://github.com/python/cpython/pull/113237/files
hugovkhttps://github.com/hugovk
Dec 17, 2023https://github.com/python/cpython/pull/113237/files#r1429253036
Please reload this pagehttps://github.com/python/cpython/pull/113237/files
Learn morehttps://docs.github.com/articles/managing-disruptive-comments/#hiding-a-comment
https://private-user-images.githubusercontent.com/1324225/291101479-00abadeb-eb51-4d70-b86b-f974194d1895.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Njg1NzMwODMsIm5iZiI6MTc2ODU3Mjc4MywicGF0aCI6Ii8xMzI0MjI1LzI5MTEwMTQ3OS0wMGFiYWRlYi1lYjUxLTRkNzAtYjg2Yi1mOTc0MTk0ZDE4OTUucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI2MDExNiUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNjAxMTZUMTQxMzAzWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9M2Y0ZmEzYmQ2MmI3YTJlZDg0Y2E4ODg4YTgyN2E0NWVhYTE0Y2NlZThiNzM5MmNlNmY5MjczNmMwMWQ1ODI5ZSZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.kMG3CTblvEeOydp_3H4HSAK4Y3ADQi-Hs99WDQRmGqg
https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.pax_headershttps://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.pax_headers
https://private-user-images.githubusercontent.com/1324225/291101175-9bd66a4f-93a8-43ac-9424-1cd3f4fef218.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Njg1NzMwODMsIm5iZiI6MTc2ODU3Mjc4MywicGF0aCI6Ii8xMzI0MjI1LzI5MTEwMTE3NS05YmQ2NmE0Zi05M2E4LTQzYWMtOTQyNC0xY2QzZjRmZWYyMTgucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI2MDExNiUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNjAxMTZUMTQxMzAzWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9ZTNlOTFjMjU4YWViNmEzNTY3ZWExZTU0YjBkYjlhNTM2NTk0MWE4ZmJlMjk2ZmZhODlhMmMwOWM2NDZhZWVhOSZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.r2Z4ibnpJNI6juJdtAmR27CC9W-qoSFjHFspwutp_yg
https://cpython-previews--113237.org.readthedocs.build/en/113237/library/tarfile.html#tarfile.TarInfo.replacehttps://cpython-previews--113237.org.readthedocs.build/en/113237/library/tarfile.html#tarfile.TarInfo.replace
Please reload this pagehttps://github.com/python/cpython/pull/113237/files
https://github.com/python/cpython/pull/113237/files#diff-130eff7d2ababf1fb3d3b179e70d48e4c3ad8f7dc32d15a5267fde82a664928c
https://github.com/python/cpython/pull/113237/files#diff-130eff7d2ababf1fb3d3b179e70d48e4c3ad8f7dc32d15a5267fde82a664928c
https://github.com/python/cpython/pull/113237/files#diff-130eff7d2ababf1fb3d3b179e70d48e4c3ad8f7dc32d15a5267fde82a664928c
https://github.com/python/cpython/pull/113237/files#diff-130eff7d2ababf1fb3d3b179e70d48e4c3ad8f7dc32d15a5267fde82a664928c
https://github.com/python/cpython/pull/113237/files#diff-130eff7d2ababf1fb3d3b179e70d48e4c3ad8f7dc32d15a5267fde82a664928c
https://github.com/python/cpython/blob/main/.github/CODEOWNERS#L107
Doc/tools/.nitignorehttps://github.com/python/cpython/pull/113237/files#diff-b7c84835b887ce2fbbbbdbfb8aaee3317c5b731ed4c6c4682e122de334984c9c
View file https://github.com/hugovk/cpython/blob/fbcf9598a4d859ce604deccdaea7d345197f7266/Doc/tools/.nitignore
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/python/cpython/pull/113237/{{ revealButtonHref }}
https://github.com/python/cpython/pull/113237/files#diff-b7c84835b887ce2fbbbbdbfb8aaee3317c5b731ed4c6c4682e122de334984c9c
https://github.com/python/cpython/pull/113237/files#diff-b7c84835b887ce2fbbbbdbfb8aaee3317c5b731ed4c6c4682e122de334984c9c
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.