Title: Create a method for usage instructions · Issue #222 · usethis-python/usethis-python · GitHub
Open Graph Title: Create a method for usage instructions · Issue #222 · usethis-python/usethis-python
X Title: Create a method for usage instructions · Issue #222 · usethis-python/usethis-python
Description: Motivation At the moment there is a pattern arising which I think is harmful: Tool A integrates with tool B. When Tool A is being added, it checks whether B is being used. If so, it re-calls use_B so that new usage instructions which are...
Open Graph Description: Motivation At the moment there is a pattern arising which I think is harmful: Tool A integrates with tool B. When Tool A is being added, it checks whether B is being used. If so, it re-calls use_B ...
X Description: Motivation At the moment there is a pattern arising which I think is harmful: Tool A integrates with tool B. When Tool A is being added, it checks whether B is being used. If so, it re-calls use_B ...
Opengraph URL: https://github.com/usethis-python/usethis-python/issues/222
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Create a method for usage instructions","articleBody":"**Motivation**\nAt the moment there is a pattern arising which I think is harmful:\n1. Tool A integrates with tool B.\n2. When Tool A is being added, it checks whether B is being used. If so, it re-calls use_B so that new usage instructions which are relevant to A are displayed.\n3. Likewise, when Tool A is being removed, it checks whether B is being used. If so, it re-calls use_B so that the usage instructions relevant to _not_ using A are displayed.\n\nThe issue is that sometimes usage instructions for the not-using-A case suggest using A! Given there is an integration at all, it makes sense we would want to recommend that. Also it degrades performance to run checks to ascertain whether a tool is used or not.\n\nSo one idea is that we wouldn't re-call use_B, we would just call specifically the message which is helpful which contains usage directions. The hints about using A etc. would remain in the place they currently are.\n\n**Summary of desired enhancement**\nCreate method functions which specialize in usage instructions.\n","author":{"url":"https://github.com/nathanjmcdougall","@type":"Person","name":"nathanjmcdougall"},"datePublished":"2025-01-18T03:27:55.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/222/usethis-python/issues/222"}
| 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:83e7b8a6-6848-a7d6-a206-913018095055 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 9EAE:358B3C:1D76C2E:2A4CA84:6A4F8760 |
| html-safe-nonce | bc03dbb40d8b579cf782f8654574dfbabd624f68759ce65be250082f9423fb01 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5RUFFOjM1OEIzQzoxRDc2QzJFOjJBNENBODQ6NkE0Rjg3NjAiLCJ2aXNpdG9yX2lkIjoiNzY5NDYwNjUwMTUzMzQxOTM2MSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 6fef0e7cbafdf1ba36b9dc61ccf9666b46d537c5bc1aae8aa6cab73431508cb4 |
| hovercard-subject-tag | issue:2796617138 |
| 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/222/issue_layout |
| twitter:image | https://opengraph.githubassets.com/d656fb4bd90c43038b85c849ab49347371bdc2730175a9b8d728853cb30b7eb2/usethis-python/usethis-python/issues/222 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/d656fb4bd90c43038b85c849ab49347371bdc2730175a9b8d728853cb30b7eb2/usethis-python/usethis-python/issues/222 |
| og:image:alt | Motivation At the moment there is a pattern arising which I think is harmful: Tool A integrates with tool B. When Tool A is being added, it checks whether B is being used. If so, it re-calls use_B ... |
| 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 | b92d11c0aa4a77d54ef4af1078b6a15fb5a70a215b30c4ecf28889d5a8e656d9 |
| 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 | 4b249b445842943ed31549e027f57a8ade9881ed |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width