Title: `pospell` fails with code entries · Issue #3324 · python/python-docs-es · GitHub
Open Graph Title: `pospell` fails with code entries · Issue #3324 · python/python-docs-es
X Title: `pospell` fails with code entries · Issue #3324 · python/python-docs-es
Description: For 3.13, there was a change in the documentation that now snippets were marked as translatable. This means that there is a large number of "new entries" that are snippets from the documentation page. Even though I believe this is a grea...
Open Graph Description: For 3.13, there was a change in the documentation that now snippets were marked as translatable. This means that there is a large number of "new entries" that are snippets from the documentation pa...
X Description: For 3.13, there was a change in the documentation that now snippets were marked as translatable. This means that there is a large number of "new entries" that are snippets from the docume...
Opengraph URL: https://github.com/python/python-docs-es/issues/3324
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"`pospell` fails with code entries","articleBody":"For 3.13, there was a change in the documentation that now snippets were marked as translatable.\r\nThis means that there is a large number of \"new entries\" that are snippets from the documentation page.\r\n\r\nEven though I believe this is a great thing, the tooling around might need to be adapted.\r\nRecently I discovered that in some cases, `pospell` fails to parse and handle such entries.\r\n\r\nFor example:\r\n\r\n```\r\n#: ../Doc/library/typing.rst:3167\r\nmsgid \"\"\r\n\"@type_check_only\\n\"\r\n\"class Response: # private or not available at runtime\\n\"\r\n\" code: int\\n\"\r\n\" def get_header(self, name: str) -\u003e str: ...\\n\"\r\n\"\\n\"\r\n\"def fetch_response() -\u003e Response: ...\"\r\nmsgstr \"\"\r\n\"@type_check_only\\n\"\r\n\"class Response: # privada o no disponible en runtime\\n\"\r\n\" code: int\\n\"\r\n\" def get_header(self, name: str) -\u003e str: ...\\n\"\r\n\"\\n\"\r\n\"def fetch_response() -\u003e Response: ...\"\r\n```\r\n\r\nProduces a \r\n```\r\n\u003crst-doc\u003e:3: (ERROR/3) Unexpected indentation. while parsing: @type_check_only\r\nclass Response: # privada o no disponible en runtime\r\n code: int\r\n def get_header(self, name: str) -\u003e str: ...\r\n\r\ndef fetch_response() -\u003e Response: ...\r\n```\r\n\r\nMarking those entries as fuzzy or adding three back-ticks \"```\" doesn't work, so I'm trying to brainstorm a bit how we could solve this.\r\nA couple of ideas would be to:\r\n\r\n1. Just try to fix at the docutils level (which is the source of the parsing error)\r\n2. Introduce a new identifier like `python-format` in order to take the content for granted and avoid parsing it.\r\n\r\nIdeas?\r\n\r\nCC: @JulienPalard ","author":{"url":"https://github.com/cmaureir","@type":"Person","name":"cmaureir"},"datePublished":"2024-11-24T14:01:36.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/3324/python-docs-es/issues/3324"}
| 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:59992fc1-cdad-79c8-6f7e-ddf62fd48b3f |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | A13C:2A0D62:1A0CA12:23D645F:696AB214 |
| html-safe-nonce | fb7c5d1c824c3da79d287d6f9eb2c499bf954dcbd8051ede478ae509631cfff0 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBMTNDOjJBMEQ2MjoxQTBDQTEyOjIzRDY0NUY6Njk2QUIyMTQiLCJ2aXNpdG9yX2lkIjoiNzk4OTI3NDg2NjE0MzExMzc0OCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 84038760f82d151623de5f57cda9ae96141ffa56e366b4c898d10d6c85aae28e |
| hovercard-subject-tag | issue:2687771193 |
| 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/python-docs-es/3324/issue_layout |
| twitter:image | https://opengraph.githubassets.com/5f30538e0baa61107d59f8df3a6e8fe73115bf3663ae6f169120a459657681e8/python/python-docs-es/issues/3324 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/5f30538e0baa61107d59f8df3a6e8fe73115bf3663ae6f169120a459657681e8/python/python-docs-es/issues/3324 |
| og:image:alt | For 3.13, there was a change in the documentation that now snippets were marked as translatable. This means that there is a large number of "new entries" that are snippets from the documentation pa... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | cmaureir |
| hostname | github.com |
| expected-hostname | github.com |
| None | 4fa1799b6a53c2d30c950d74230781bef9e7f61138c72c7727e4b83f0743752b |
| turbo-cache-control | no-preview |
| go-import | github.com/python/python-docs-es git https://github.com/python/python-docs-es.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 185224402 |
| octolytics-dimension-repository_nwo | python/python-docs-es |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 185224402 |
| octolytics-dimension-repository_network_root_nwo | python/python-docs-es |
| 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 | 41f276818bd204c4a30a0281fb3c576298d9474c |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width