Title: When documenting in the CLI reference, don't include excessive detail · Issue #1577 · usethis-python/usethis-python · GitHub
Open Graph Title: When documenting in the CLI reference, don't include excessive detail · Issue #1577 · usethis-python/usethis-python
X Title: When documenting in the CLI reference, don't include excessive detail · Issue #1577 · usethis-python/usethis-python
Description: In #1565, the agent tried to introduce excessive detail into the CLI reference. It would be better to keep the reference factual. If the context is especially import, it belongs in a separate .md file, with a hyperlink to it from the CLI...
Open Graph Description: In #1565, the agent tried to introduce excessive detail into the CLI reference. It would be better to keep the reference factual. If the context is especially import, it belongs in a separate .md f...
X Description: In #1565, the agent tried to introduce excessive detail into the CLI reference. It would be better to keep the reference factual. If the context is especially import, it belongs in a separate .md f...
Opengraph URL: https://github.com/usethis-python/usethis-python/issues/1577
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"When documenting in the CLI reference, don't include excessive detail","articleBody":"In #1565, the agent tried to introduce excessive detail into the CLI reference. It would be better to keep the reference factual.\n\nIf the context is especially import, it belongs in a separate `.md` file, with a hyperlink to it from the CLI reference.\n\nGood:\n\n```\n- `--output-file` to write the output to a file instead of stdout.\n```\n\nBad:\n\n```\n- `--output-file` to write the output to a file instead of stdout. This is useful to avoid issues when shell redirects (e.g. `\u003e file.txt`) create the file before the command runs, which can influence the behaviour of `usethis show`.\n```","author":{"url":"https://github.com/nathanjmcdougall","@type":"Person","name":"nathanjmcdougall"},"datePublished":"2026-03-27T01:59:10.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/1577/usethis-python/issues/1577"}| 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:d85dff72-925f-0924-d62a-ea3d5dd60da4 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | A8DE:2C7266:9FB9B2:DED579:6A4C9F22 |
| html-safe-nonce | ce2ba506b70a3ad1c73b9f5c77b6e47e4dd289c8e06f8dbf90f003298e92a70e |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBOERFOjJDNzI2Njo5RkI5QjI6REVENTc5OjZBNEM5RjIyIiwidmlzaXRvcl9pZCI6IjE5NzM3MzMyNDMxOTk3MjUzNDciLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | d468bd9f197015c24cf2aa3f8c182f6cf373734c7e2cb7a5556bc531ba2f04f6 |
| hovercard-subject-tag | issue:4148538393 |
| 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/1577/issue_layout |
| twitter:image | https://opengraph.githubassets.com/8725ae17434ceccaf94131cd811571e5262ee14eb2ca0bfed62bee55f5e44e1b/usethis-python/usethis-python/issues/1577 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/8725ae17434ceccaf94131cd811571e5262ee14eb2ca0bfed62bee55f5e44e1b/usethis-python/usethis-python/issues/1577 |
| og:image:alt | In #1565, the agent tried to introduce excessive detail into the CLI reference. It would be better to keep the reference factual. If the context is especially import, it belongs in a separate .md f... |
| 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