René's URL Explorer Experiment


Title: Add prek hook to forbid double backticks in docstrings · Issue #1822 · usethis-python/usethis-python · GitHub

Open Graph Title: Add prek hook to forbid double backticks in docstrings · Issue #1822 · usethis-python/usethis-python

X Title: Add prek hook to forbid double backticks in docstrings · Issue #1822 · usethis-python/usethis-python

Description: Problem Agents (and developers) sometimes write Python docstrings using RST double-backtick markup (e.g. install_requires) when single backticks should be used instead. This was caught in code review on PR #1795. Double backticks are RST...

Open Graph Description: Problem Agents (and developers) sometimes write Python docstrings using RST double-backtick markup (e.g. install_requires) when single backticks should be used instead. This was caught in code revi...

X Description: Problem Agents (and developers) sometimes write Python docstrings using RST double-backtick markup (e.g. install_requires) when single backticks should be used instead. This was caught in code revi...

Opengraph URL: https://github.com/usethis-python/usethis-python/issues/1822

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Add prek hook to forbid double backticks in docstrings","articleBody":"## Problem\n\nAgents (and developers) sometimes write Python docstrings using RST double-backtick markup (e.g. ``install_requires``) when single backticks should be used instead. This was caught in code review on PR #1795.\n\nDouble backticks are RST-style code spans, but this project does not use RST-rendered docstrings. Single backticks are preferred for inline code references in docstrings.\n\n## Solution\n\nAdd a bespoke prek hook that scans Python files and fails if any docstring lines contain ````...```` (double backtick patterns).\n\n- The hook should be a CLI script accepting a list of files\n- It should parse Python files and check only docstring content (not code)\n- Should report file/line/column of violations\n- Example pattern to forbid: ````foo````\n\n## Agent Skill Update\n\nUpdate the relevant agent skills (e.g. `usethis-python-code`) to explicitly note: do NOT use double backticks in docstrings. Use single backticks for inline code references.","author":{"url":"https://github.com/nathanjmcdougall","@type":"Person","name":"nathanjmcdougall"},"datePublished":"2026-04-06T18:53:29.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/1822/usethis-python/issues/1822"}

route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:ee16bafb-a263-85b8-8123-ccfbdec627a6
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idD726:2D2253:1D35D55:2A08D6B:6A4CE7B1
html-safe-nonce5ff4701edb662bc668e73692ed7f32118dbb456621e04bfb3ebc5d9223947e5c
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJENzI2OjJEMjI1MzoxRDM1RDU1OjJBMDhENkI6NkE0Q0U3QjEiLCJ2aXNpdG9yX2lkIjoiMzQxMjE5OTcwNzQxMjMzNTg1IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0=
visitor-hmacad2ed856fafab9947d7769f31797a706e3794084d0f85ea1342702a08c55f0d5
hovercard-subject-tagissue:4213485196
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/usethis-python/usethis-python/1822/issue_layout
twitter:imagehttps://opengraph.githubassets.com/90fea50c4ae76a0537ab93c638f1e61462ba16875968021a3bc367f31ffd7e4b/usethis-python/usethis-python/issues/1822
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/90fea50c4ae76a0537ab93c638f1e61462ba16875968021a3bc367f31ffd7e4b/usethis-python/usethis-python/issues/1822
og:image:altProblem Agents (and developers) sometimes write Python docstrings using RST double-backtick markup (e.g. install_requires) when single backticks should be used instead. This was caught in code revi...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamenathanjmcdougall
hostnamegithub.com
expected-hostnamegithub.com
None299b43bca6e02ad35197ffeba30d2466846d5fb02ab96fbced5b5e6cec589fb8
turbo-cache-controlno-preview
go-importgithub.com/usethis-python/usethis-python git https://github.com/usethis-python/usethis-python.git
octolytics-dimension-user_id216362695
octolytics-dimension-user_loginusethis-python
octolytics-dimension-repository_id842189705
octolytics-dimension-repository_nwousethis-python/usethis-python
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id842189705
octolytics-dimension-repository_network_root_nwousethis-python/usethis-python
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
releasec5a57f04eeb310f57c73fd6d751d957e2ca27ed2
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/usethis-python/usethis-python/issues/1822#start-of-content
https://github.com/
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fusethis-python%2Fusethis-python%2Fissues%2F1822
GitHub CopilotWrite better code with AIhttps://github.com/features/copilot
GitHub Copilot appDirect agents from issue to mergehttps://github.com/features/ai/github-app
MCP RegistryNewIntegrate external toolshttps://github.com/mcp
ActionsAutomate any workflowhttps://github.com/features/actions
CodespacesInstant dev environmentshttps://github.com/features/codespaces
IssuesPlan and track workhttps://github.com/features/issues
Code ReviewManage code changeshttps://github.com/features/code-review
GitHub Advanced SecurityFind and fix vulnerabilitieshttps://github.com/security/advanced-security
Code securitySecure your code as you buildhttps://github.com/security/advanced-security/code-security
Secret protectionStop leaks before they starthttps://github.com/security/advanced-security/secret-protection
Why GitHubhttps://github.com/why-github
Documentationhttps://docs.github.com
Bloghttps://github.blog
Changeloghttps://github.blog/changelog
Marketplacehttps://github.com/marketplace
View all featureshttps://github.com/features
Enterpriseshttps://github.com/enterprise
Small and medium teamshttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
App Modernizationhttps://github.com/solutions/use-case/app-modernization
DevSecOpshttps://github.com/solutions/use-case/devsecops
DevOpshttps://github.com/solutions/use-case/devops
CI/CDhttps://github.com/solutions/use-case/ci-cd
View all use caseshttps://github.com/solutions/use-case
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
View all industrieshttps://github.com/solutions/industry
View all solutionshttps://github.com/solutions
AIhttps://github.com/resources/articles?topic=ai
Software Developmenthttps://github.com/resources/articles?topic=software-development
DevOpshttps://github.com/resources/articles?topic=devops
Securityhttps://github.com/resources/articles?topic=security
View all topicshttps://github.com/resources/articles
Customer storieshttps://github.com/customer-stories
Events & webinarshttps://github.com/resources/events
Ebooks & reportshttps://github.com/resources/whitepapers
Business insightshttps://github.com/solutions/executive-insights
GitHub Skillshttps://skills.github.com
Documentationhttps://docs.github.com
Customer supporthttps://support.github.com
Community forumhttps://github.com/orgs/community/discussions
Trust centerhttps://github.com/trust-center
Partnershttps://github.com/partners
View all resourceshttps://github.com/resources
GitHub SponsorsFund open source developershttps://github.com/sponsors
Security Labhttps://securitylab.github.com
Maintainer Communityhttps://maintainers.github.com
Acceleratorhttps://github.com/accelerator
GitHub Starshttps://stars.github.com
Archive Programhttps://archiveprogram.github.com
Topicshttps://github.com/topics
Trendinghttps://github.com/trending
Collectionshttps://github.com/collections
Enterprise platformAI-powered developer platformhttps://github.com/enterprise
GitHub Advanced SecurityEnterprise-grade security featureshttps://github.com/security/advanced-security
Copilot for BusinessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/premium-support
Pricinghttps://github.com/pricing
Search syntax tipshttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
documentationhttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fusethis-python%2Fusethis-python%2Fissues%2F1822
Sign up https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=usethis-python%2Fusethis-python
Reloadhttps://github.com/usethis-python/usethis-python/issues/1822
Reloadhttps://github.com/usethis-python/usethis-python/issues/1822
Reloadhttps://github.com/usethis-python/usethis-python/issues/1822
Please reload this pagehttps://github.com/usethis-python/usethis-python/issues/1822
usethis-python https://github.com/usethis-python
usethis-pythonhttps://github.com/usethis-python/usethis-python
Notifications https://github.com/login?return_to=%2Fusethis-python%2Fusethis-python
Fork 5 https://github.com/login?return_to=%2Fusethis-python%2Fusethis-python
Star 19 https://github.com/login?return_to=%2Fusethis-python%2Fusethis-python
Code https://github.com/usethis-python/usethis-python
Issues 163 https://github.com/usethis-python/usethis-python/issues
Pull requests 4 https://github.com/usethis-python/usethis-python/pulls
Actions https://github.com/usethis-python/usethis-python/actions
Security and quality 0 https://github.com/usethis-python/usethis-python/security
Insights https://github.com/usethis-python/usethis-python/pulse
Code https://github.com/usethis-python/usethis-python
Issues https://github.com/usethis-python/usethis-python/issues
Pull requests https://github.com/usethis-python/usethis-python/pulls
Actions https://github.com/usethis-python/usethis-python/actions
Security and quality https://github.com/usethis-python/usethis-python/security
Insights https://github.com/usethis-python/usethis-python/pulse
#1828https://github.com/usethis-python/usethis-python/pull/1828
Add prek hook to forbid double backticks in docstringshttps://github.com/usethis-python/usethis-python/issues/1822#top
#1828https://github.com/usethis-python/usethis-python/pull/1828
https://github.com/nathanjmcdougall
https://github.com/copilot-swe-agent
https://github.com/nathanjmcdougall
nathanjmcdougallhttps://github.com/nathanjmcdougall
on Apr 6, 2026https://github.com/usethis-python/usethis-python/issues/1822#issue-4213485196
#1795https://github.com/usethis-python/usethis-python/pull/1795
Copilothttps://github.com/apps/copilot-swe-agent
nathanjmcdougallhttps://github.com/nathanjmcdougall
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.