Title: Add prek hook to forbid double backticks in docstrings by Copilot · Pull Request #1826 · usethis-python/usethis-python · GitHub
Open Graph Title: Add prek hook to forbid double backticks in docstrings by Copilot · Pull Request #1826 · usethis-python/usethis-python
X Title: Add prek hook to forbid double backticks in docstrings by Copilot · Pull Request #1826 · usethis-python/usethis-python
Description: Agents and developers sometimes write RST-style double backtick markup ( foo ) in docstrings when single backticks should be used. This project uses Markdown-compatible docstrings, not RST. New hook: hooks/check-docstring-substrings.py General-purpose prek hook that parses Python files with ast, extracts only docstring nodes, and checks them for forbidden substrings. Accepts --forbidden args and file paths: - id: check-docstring-substrings entry: uv run --frozen --offline hooks/check-docstring-substrings.py args: ["--forbidden", "``"] types: [python] Multiple forbidden substrings supported via repeated --forbidden flags. Existing violations fixed Converted all ... → `...` in docstrings across 12 files in src/ and hooks/. One triple-backtick code fence in imports.py converted to an indented code block to avoid false positives.
Open Graph Description: Agents and developers sometimes write RST-style double backtick markup ( foo ) in docstrings when single backticks should be used. This project uses Markdown-compatible docstrings, not RST. New hoo...
X Description: Agents and developers sometimes write RST-style double backtick markup ( foo ) in docstrings when single backticks should be used. This project uses Markdown-compatible docstrings, not RST. New hoo...
Opengraph URL: https://github.com/usethis-python/usethis-python/pull/1826
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:3af796e1-0ef8-0a36-2030-c98b885d56f6 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | E9BC:3E81B:372DE:4A1A6:6A4D7896 |
| html-safe-nonce | eb967e7fdb6d5e6f6bdd0871346859c87db6f85d0cf82554612f955d0e97b2fd |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJFOUJDOjNFODFCOjM3MkRFOjRBMUE2OjZBNEQ3ODk2IiwidmlzaXRvcl9pZCI6IjQ4ODMzNjczOTM0NDk4MzQ2NDYiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | cbd76bc434c24cb2a337e4902cff89bbfac1acecd2ad173f1738392ffe9a2885 |
| hovercard-subject-tag | pull_request:3494575652 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,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/usethis-python/usethis-python/pull/1826/files |
| twitter:image | https://avatars.githubusercontent.com/in/1143301?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/in/1143301?s=400&v=4 |
| og:image:alt | Agents and developers sometimes write RST-style double backtick markup ( foo ) in docstrings when single backticks should be used. This project uses Markdown-compatible docstrings, not RST. New hoo... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 7f8e15305e2ab58890ca84b830615e375f5df303cf471cafcba0c08272981be3 |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/usethis-python/usethis-python git https://github.com/usethis-python/usethis-python.git |
| octolytics-dimension-user_id | 216362695 |
| octolytics-dimension-user_login | usethis-python |
| octolytics-dimension-repository_id | 842189705 |
| octolytics-dimension-repository_nwo | usethis-python/usethis-python |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 842189705 |
| octolytics-dimension-repository_network_root_nwo | usethis-python/usethis-python |
| turbo-body-classes | logged-out env-production page-responsive full-width |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 8608b0750fc35e283e5ec5b094bff942d7a0e197 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width