Title: lesson: always update docs/cli/reference.md when adding new CLI flags · Issue #1811 · usethis-python/usethis-python · GitHub
Open Graph Title: lesson: always update docs/cli/reference.md when adding new CLI flags · Issue #1811 · usethis-python/usethis-python
X Title: lesson: always update docs/cli/reference.md when adding new CLI flags · Issue #1811 · usethis-python/usethis-python
Description: When a new CLI flag is added (e.g. --output-file for usethis tool requirements.txt), docs/cli/reference.md must be updated to document it. This was overlooked when adding --output-file in PR #1794 — the flag was implemented and tested bu...
Open Graph Description: When a new CLI flag is added (e.g. --output-file for usethis tool requirements.txt), docs/cli/reference.md must be updated to document it. This was overlooked when adding --output-file in PR #1794 ...
X Description: When a new CLI flag is added (e.g. --output-file for usethis tool requirements.txt), docs/cli/reference.md must be updated to document it. This was overlooked when adding --output-file in PR #1794 ...
Opengraph URL: https://github.com/usethis-python/usethis-python/issues/1811
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"lesson: always update docs/cli/reference.md when adding new CLI flags","articleBody":"When a new CLI flag is added (e.g. `--output-file` for `usethis tool requirements.txt`), `docs/cli/reference.md` must be updated to document it.\n\nThis was overlooked when adding `--output-file` in PR #1794 — the flag was implemented and tested but not documented.\n\n**What:** Failing to update `docs/cli/reference.md` when introducing new options.\n**Where:** `docs/cli/reference.md`; `src/usethis/_ui/options.py`; `src/usethis/_ui/interface/`.\n**Why:** Users rely on the reference docs to discover available flags. Undocumented flags effectively don't exist from the user's perspective.","author":{"url":"https://github.com/nathanjmcdougall","@type":"Person","name":"nathanjmcdougall"},"datePublished":"2026-04-04T06:56:05.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/1811/usethis-python/issues/1811"}
| 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:3d19e9e2-68d3-648c-eb70-63fa0cea6759 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 8C06:32FDD1:A9077D:EC18D2:6A4C9F09 |
| html-safe-nonce | 84c74c69209e1124aef5a1e2efd41b86a18a1568a33e4f95f59b5724ce865eac |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4QzA2OjMyRkREMTpBOTA3N0Q6RUMxOEQyOjZBNEM5RjA5IiwidmlzaXRvcl9pZCI6IjQ5NzcxNjQ3MDMxOTA3ODU4MDEiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | ea44191c90f932eb40836f97492ef087f241362fbe780e09dd78bf17ceaf9a89 |
| hovercard-subject-tag | issue:4203933183 |
| 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/1811/issue_layout |
| twitter:image | https://opengraph.githubassets.com/e31faa2d820a3e951684e1708d64da206b3e07ad083d0b5237dacc393f1293c0/usethis-python/usethis-python/issues/1811 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/e31faa2d820a3e951684e1708d64da206b3e07ad083d0b5237dacc393f1293c0/usethis-python/usethis-python/issues/1811 |
| og:image:alt | When a new CLI flag is added (e.g. --output-file for usethis tool requirements.txt), docs/cli/reference.md must be updated to document it. This was overlooked when adding --output-file in PR #1794 ... |
| 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