Title: gh-101100: Fix sphinx warnings in `Doc/library/functools.rst` by LamentXU123 · Pull Request #136424 · python/cpython · GitHub
Open Graph Title: gh-101100: Fix sphinx warnings in `Doc/library/functools.rst` by LamentXU123 · Pull Request #136424 · python/cpython
X Title: gh-101100: Fix sphinx warnings in `Doc/library/functools.rst` by LamentXU123 · Pull Request #136424 · python/cpython
Description: before: C:\Users\admin\Downloads\cpython-main\Doc\library\functools.rst:202: WARNING: py:func reference target not found: cache_info [ref.func] C:\Users\admin\Downloads\cpython-main\Doc\library\functools.rst:207: WARNING: py:func reference target not found: cache_clear [ref.func] C:\Users\admin\Downloads\cpython-main\Doc\library\functools.rst:287: WARNING: py:meth reference target not found: __lt__ [ref.meth] C:\Users\admin\Downloads\cpython-main\Doc\library\functools.rst:287: WARNING: py:meth reference target not found: __le__ [ref.meth] C:\Users\admin\Downloads\cpython-main\Doc\library\functools.rst:287: WARNING: py:meth reference target not found: __gt__ [ref.meth] C:\Users\admin\Downloads\cpython-main\Doc\library\functools.rst:287: WARNING: py:meth reference target not found: __ge__ [ref.meth] C:\Users\admin\Downloads\cpython-main\Doc\library\functools.rst:287: WARNING: py:meth reference target not found: __eq__ [ref.meth] C:\Users\admin\Downloads\cpython-main\Doc\library\functools.rst:420: WARNING: py:func reference target not found: abstractmethod [ref.func] C:\Users\admin\Downloads\cpython-main\Doc\library\functools.rst:502: WARNING: py:func reference target not found: register [ref.func] C:\Users\admin\Downloads\cpython-main\Doc\library\functools.rst:567: WARNING: py:func reference target not found: register [ref.func] C:\Users\admin\Downloads\cpython-main\Doc\library\functools.rst:575: WARNING: py:func reference target not found: register [ref.func] C:\Users\admin\Downloads\cpython-main\Doc\library\functools.rst:653: WARNING: py:func reference target not found: register [ref.func] C:\Users\admin\Downloads\cpython-main\Doc\library\functools.rst:656: WARNING: py:func reference target not found: register [ref.func] C:\Users\admin\Downloads\cpython-main\Doc\library\functools.rst:785: WARNING: py:func reference target not found: example [ref.func] This PR fix them all, I will explain all my changes: link to cache_info and cache_clear are subpressed. Same to the formar subpressed link cache_parameters Create an index entries and anchor of cache_info and cache_clear __lt__ , __le__, __gt__, __ge__, __eq__ are magic methods of object. So It's changed to ~object.__lt__, etc. abstractmethod is actually referring to abc.abstractmethod. So it's changed to ~abc.abstractmethod register is actually a function of generic function. Since we don't get a doc about it., the link is supressed. Create an index entries and anchor of register example is an example function. The link is supressed. Thanks! The doc preview of this PR on this library: https://cpython-previews--136424.org.readthedocs.build/en/136424/library/functools.html Issue: gh-101100 📚 Documentation preview 📚: https://cpython-previews--136424.org.readthedocs.build/
Open Graph Description: before: C:\Users\admin\Downloads\cpython-main\Doc\library\functools.rst:202: WARNING: py:func reference target not found: cache_info [ref.func] C:\Users\admin\Downloads\cpython-main\Doc\library\fun...
X Description: before: C:\Users\admin\Downloads\cpython-main\Doc\library\functools.rst:202: WARNING: py:func reference target not found: cache_info [ref.func] C:\Users\admin\Downloads\cpython-main\Doc\library\fun...
Opengraph URL: https://github.com/python/cpython/pull/136424
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/checks(.:format) |
| route-controller | pull_requests |
| route-action | checks |
| fetch-nonce | v2:72874c18-b09d-a5c3-0c50-e11418435421 |
| current-catalog-service-hash | 87dc3bc62d9b466312751bfd5f889726f4f1337bdff4e8be7da7c93d6c00a25a |
| request-id | 9708:1AD94A:2AF114:38DDB4:6969C129 |
| html-safe-nonce | 769f099a64841ec2e31513ae646c157775211bd7674579630c08f73df4c98d81 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5NzA4OjFBRDk0QToyQUYxMTQ6MzhEREI0OjY5NjlDMTI5IiwidmlzaXRvcl9pZCI6IjM4OTgxMTA2MDU5MjYxODczMDUiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | fe4d31b59fe949ba731f6af09cdabffa0d1a6ac3b6dcb94e4abb933d4c79a8e0 |
| hovercard-subject-tag | pull_request:2650282250 |
| 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/136424/checks |
| twitter:image | https://avatars.githubusercontent.com/u/108666168?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/108666168?s=400&v=4 |
| og:image:alt | before: C:\Users\admin\Downloads\cpython-main\Doc\library\functools.rst:202: WARNING: py:func reference target not found: cache_info [ref.func] C:\Users\admin\Downloads\cpython-main\Doc\library\fun... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | acedec8b5f975d9e3d494ddd8f949b0b8a0de59d393901e26f73df9dcba80056 |
| turbo-cache-control | no-cache |
| 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 | 83c08c21cdda978090dc44364b71aa5bc6dcea79 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width