Title: Fix `usethis show` docs gaps and add CLI doc integrity skill by Copilot · Pull Request #1813 · usethis-python/usethis-python · GitHub
Open Graph Title: Fix `usethis show` docs gaps and add CLI doc integrity skill by Copilot · Pull Request #1813 · usethis-python/usethis-python
X Title: Fix `usethis show` docs gaps and add CLI doc integrity skill by Copilot · Pull Request #1813 · usethis-python/usethis-python
Description: docs/cli/reference.md had drifted from the code in the usethis show section: usethis show license was absent from the subcommand list, --output-file was documented only under sonarqube despite applying to all four show subcommands, and --project-key was undocumented. Changes docs/cli/reference.md Add usethis show license to the subcommand inventory Promote --output-file to the parent usethis show section (shared by all subcommands) Document --project-key in the usethis show sonarqube subsection as its only command-specific option usethis-cli-modify skill (v1.4 → v1.5) Add explicit guidance to cross-check every option parameter in modified command signatures against the reference docs — shared options (defined once, reused across commands) are the most common miss Reference the new usethis-qa-doc-integrity skill for systematic audits New usethis-qa-doc-integrity skill (v1.0) Procedure for auditing CLI doc coverage: compare _ui/interface/ signatures against docs/cli/reference.md Calls out the three gap categories: missing options, missing subcommands, stale entries Documents when shared options may be documented at group level vs. per-subcommand
Open Graph Description: docs/cli/reference.md had drifted from the code in the usethis show section: usethis show license was absent from the subcommand list, --output-file was documented only under sonarqube despite appl...
X Description: docs/cli/reference.md had drifted from the code in the usethis show section: usethis show license was absent from the subcommand list, --output-file was documented only under sonarqube despite appl...
Opengraph URL: https://github.com/usethis-python/usethis-python/pull/1813
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:6c55d76c-3f4c-c204-8d73-801e990f1086 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | AE56:4D576:1E1B60F:2B522E7:6A4CE9FB |
| html-safe-nonce | b5a4504dd3cd95fcd137f24395291989e68fb81e81706d49c80f7f3087caee1f |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBRTU2OjRENTc2OjFFMUI2MEY6MkI1MjJFNzo2QTRDRTlGQiIsInZpc2l0b3JfaWQiOiI1ODEwNjU0NjQ2NTg3MTU2OTg3IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | e9039d05de10038360256467b585554a2d85300922360879fb4974a9bdaeabd3 |
| hovercard-subject-tag | pull_request:3488664322 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,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/usethis-python/usethis-python/pull/1813/files |
| twitter:image | https://avatars.githubusercontent.com/in/1143301?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/in/1143301?s=400&v=4 |
| og:image:alt | docs/cli/reference.md had drifted from the code in the usethis show section: usethis show license was absent from the subcommand list, --output-file was documented only under sonarqube despite appl... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 299b43bca6e02ad35197ffeba30d2466846d5fb02ab96fbced5b5e6cec589fb8 |
| turbo-cache-control | no-preview |
| diff-view | unified |
| 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 full-width |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | c5a57f04eeb310f57c73fd6d751d957e2ca27ed2 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width