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
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/checks(.:format) |
| route-controller | pull_requests |
| route-action | checks |
| fetch-nonce | v2:61d1f8f4-eef3-c4ec-3ab9-2d9bec408ad8 |
| current-catalog-service-hash | 87dc3bc62d9b466312751bfd5f889726f4f1337bdff4e8be7da7c93d6c00a25a |
| request-id | E27A:34359D:1C1267B:2779B07:696A53A6 |
| html-safe-nonce | d01dee17fcfb331c60e72394a2e968cf954b96343352484b6a6bdbdd8102d5a0 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFMjdBOjM0MzU5RDoxQzEyNjdCOjI3NzlCMDc6Njk2QTUzQTYiLCJ2aXNpdG9yX2lkIjoiNjE2MjU4Njk1OTc1MTA0MTk1OCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 22d2146e51c4ffe48b35d26c3477e29c810ce690b08c4626a202d4db928ae665 |
| hovercard-subject-tag | pull_request:1647418122 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,checks,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/python/cpython/pull/113237/checks |
| twitter:image | https://avatars.githubusercontent.com/u/1324225?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/1324225?s=400&v=4 |
| og:image:alt | 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... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 3f871c8e07f0ae1886fa8dac284166d28b09ad5bada6476fc10b674e489788ef |
| turbo-cache-control | no-preview |
| go-import | github.com/python/cpython git https://github.com/python/cpython.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 81598961 |
| octolytics-dimension-repository_nwo | python/cpython |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 81598961 |
| octolytics-dimension-repository_network_root_nwo | python/cpython |
| turbo-body-classes | logged-out env-production page-responsive full-width full-width-p-0 |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 63c426b30d262aba269ef14c40e3c817b384cd61 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width