Title: Agent config to explain the principle of using docstring for reference material · Issue #1625 · usethis-python/usethis-python · GitHub
Open Graph Title: Agent config to explain the principle of using docstring for reference material · Issue #1625 · usethis-python/usethis-python
X Title: Agent config to explain the principle of using docstring for reference material · Issue #1625 · usethis-python/usethis-python
Description: @copilot wrong way of generating functions.txt. should use a hook similar to how we generate module-tree.txt Originally posted by @nathanjmcdougall in #1624 (comment) Rather than summarizing code objects e.g. functions, classes, and modu...
Open Graph Description: @copilot wrong way of generating functions.txt. should use a hook similar to how we generate module-tree.txt Originally posted by @nathanjmcdougall in #1624 (comment) Rather than summarizing code o...
X Description: @copilot wrong way of generating functions.txt. should use a hook similar to how we generate module-tree.txt Originally posted by @nathanjmcdougall in #1624 (comment) Rather than summarizing code o...
Opengraph URL: https://github.com/usethis-python/usethis-python/issues/1625
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Agent config to explain the principle of using docstring for reference material","articleBody":"@copilot+claude-sonnet-4.6 wrong way of generating functions.txt. should use a hook similar to how we generate module-tree.txt\n\n_Originally posted by @nathanjmcdougall in https://github.com/usethis-python/usethis-python/issues/1624#issuecomment-4149037996_\n\nRather than summarizing code objects e.g. functions, classes, and modules with a manually maintained reference material, it is always better to have a \"one source of truth\" mindset and use the docstring via automation hooks/packages to extract the relevant information and keep it in-sync. For example, the docs/module-tree.txt design.\n\nThis information should go into a new skill called `usethis-agents` which provides a directory for all the `usethis-skill-*` skills (again, maintained via a prek hook according to this very principle!), as well as instructions for maintaining `AGENTS.md`.\n\n ","author":{"url":"https://github.com/nathanjmcdougall","@type":"Person","name":"nathanjmcdougall"},"datePublished":"2026-03-28T23:46:38.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/1625/usethis-python/issues/1625"}
| 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:9677e844-dd97-a991-b77d-8a715e850853 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 8D20:C4B79:9ECFE2:DE6D34:6A4C9F10 |
| html-safe-nonce | 5f5bd4534af925b61d303c09f0154ee0ad972dbaac3f048de069735789077ee9 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4RDIwOkM0Qjc5OjlFQ0ZFMjpERTZEMzQ6NkE0QzlGMTAiLCJ2aXNpdG9yX2lkIjoiNTkyNzkxNDI2NjMyMDMyMDE3IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | ed28d41ef2e2c03b4141334e751196ee44346d4e153c059393f4de94fffcf229 |
| hovercard-subject-tag | issue:4161983452 |
| 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/usethis-python/usethis-python/1625/issue_layout |
| twitter:image | https://opengraph.githubassets.com/089b2e23986caa4a38e334af580f785a492fe8fdfd3b9961979de303d0bc3422/usethis-python/usethis-python/issues/1625 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/089b2e23986caa4a38e334af580f785a492fe8fdfd3b9961979de303d0bc3422/usethis-python/usethis-python/issues/1625 |
| og:image:alt | @copilot wrong way of generating functions.txt. should use a hook similar to how we generate module-tree.txt Originally posted by @nathanjmcdougall in #1624 (comment) Rather than summarizing code o... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | nathanjmcdougall |
| hostname | github.com |
| expected-hostname | github.com |
| None | 3d11bb817438277de2a940854450e83a7d32b6aeb5014e9e6b00a6423900251c |
| turbo-cache-control | no-preview |
| 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 |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | ae90d426644ca15e89bacceb72e51f4e9dbf85f7 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width