Title: Ordering of search results in the docs could be improved · Issue #138277 · python/cpython · GitHub
Open Graph Title: Ordering of search results in the docs could be improved · Issue #138277 · python/cpython
X Title: Ordering of search results in the docs could be improved · Issue #138277 · python/cpython
Description: When searching for "str" in the documentation, for example, the built-in str type shows up 44th in the list of results currently. This specific example (as well as a general notion that the search results are often not useful) was recent...
Open Graph Description: When searching for "str" in the documentation, for example, the built-in str type shows up 44th in the list of results currently. This specific example (as well as a general notion that the search ...
X Description: When searching for "str" in the documentation, for example, the built-in str type shows up 44th in the list of results currently. This specific example (as well as a general notion that t...
Opengraph URL: https://github.com/python/cpython/issues/138277
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Ordering of search results in the docs could be improved","articleBody":"When searching for \"str\" in the documentation, for example, the built-in `str` type shows up 44th in the list of results currently. This specific example (as well as a general notion that the search results are often not useful) was recently cited to me by a colleague as one reason that they choose to caution beginner students against using Python's docs compared to other alternatives, because the docs are \"hard to navigate\" and \"hard to search.\" I disagree with that assessment on the whole, but I do think that improving the ordering of the search results would make the docs easier to use and navigate, particularly for folks just starting out with Python.\n\nSphinx has a mechanism for custom sorting of search results, so it should be possible to come up with some heuristics there that improve the ordering of the results. I'll put in a PR in a little while with one small step that I think is an improvement.\n\n\u003c!-- gh-linked-prs -->\n### Linked PRs\n* gh-138278\n* gh-161196\n* gh-161197\n\u003c!-- /gh-linked-prs -->\n","author":{"url":"https://github.com/adqm","@type":"Person","name":"adqm"},"datePublished":"2025-08-31T05:10:15Z","url":"https://github.com/python/cpython/issues/138277"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:907beb54-5cc1-18d5-34d6-090877783189 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 82E8:1201C:34F3C6F:464A9E0:6B01F76C |
| html-safe-nonce | 27651f00ffc0a034daf08e8b8df1382a4881c7e30b4d2286ae51de6449619fc3 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4MkU4OjEyMDFDOjM0RjNDNkY6NDY0QTlFMDo2QjAxRjc2QyIsInZpc2l0b3JfaWQiOiIyODQ3NjI1NDI0MjcwMzkxMTQ5IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | fe3c259ef294f7088c3a9664e6aca265b700935987afdcd4d51f86903d31bc07 |
| hovercard-subject-tag | issue:3369824635 |
| github-keyboard-shortcuts | repository,issues,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/_view_fragments/issues/show/python/cpython/138277/issue_layout |
| twitter:image | https://opengraph.githubassets.com/f09bc9f16a91efd38aead9ba26a4d7d75ef12047b2b2891f762ad54eabf4f7b0/python/cpython/issues/138277 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/f09bc9f16a91efd38aead9ba26a4d7d75ef12047b2b2891f762ad54eabf4f7b0/python/cpython/issues/138277 |
| og:image:alt | When searching for "str" in the documentation, for example, the built-in str type shows up 44th in the list of results currently. This specific example (as well as a general notion that the search ... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | adqm |
| hostname | github.com |
| expected-hostname | github.com |
| None | 87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456 |
| 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 |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 423dbb54c5e7bfecc838eb387c1435eb3d0e760d |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width