Skip to content

LLM quality review: fix grammar, freshen docs, sync config-files.md#1881

Merged
nathanjmcdougall merged 2 commits intomainfrom
copilot/implement-llm-review-check
Apr 8, 2026
Merged

LLM quality review: fix grammar, freshen docs, sync config-files.md#1881
nathanjmcdougall merged 2 commits intomainfrom
copilot/implement-llm-review-check

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 8, 2026

Runs the usethis-qa-llm-review skill across the whole codebase — grammar/spelling, documentation freshness, and config-files sync.

Grammar & spelling (usethis-qa-grammar)

  • docs/start/detailed-example.md: "context aware" → "context-aware"
  • CONTRIBUTING.md: Windows-style backslash paths in the badge guide fixed to correct Unix paths
  • CONTRIBUTING.md: Stale module reference usethis._interface.toolusethis._ui.interface.tool
  • CONTRIBUTING.md: "Most method have" → "Most methods have"

Documentation freshness (usethis-qa-doc-freshness)

  • CONTRIBUTING.md: Removed the "Register the tool as a peer in PyprojectTOMLTool" step — OTHER_TOOLS was removed as dead code
  • CONTRIBUTING.md: Section renamed to "Register your Tool and ToolSpec subclasses"; added the missing step to register XyzToolSpec in ALL_TOOL_SPECS (required to keep test_in_sync_with_all_tools passing)
  • docs/cli/overview.md (→ auto-propagated to README.md): Added usethis show license to the usethis show subcommand list — added in v0.21.0 but never documented in the overview

Config files sync (usethis-qa-config-files-sync)

  • docs/about/config-files.md: Added missing ### pyproject.toml and ### requirements.txt sections (present in config-files.txt but absent from the hand-maintained doc page)

Copilot AI linked an issue Apr 8, 2026 that may be closed by this pull request
… CONTRIBUTING

Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/3b8b90b9-80e1-4d3e-be9c-781465546d62

Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Copilot AI changed the title [WIP] Run LLM review using doc integrity check LLM quality review: fix grammar, freshen docs, sync config-files.md Apr 8, 2026
Copilot AI requested a review from nathanjmcdougall April 8, 2026 00:23
@nathanjmcdougall nathanjmcdougall marked this pull request as ready for review April 8, 2026 00:25
@nathanjmcdougall nathanjmcdougall merged commit 1237b45 into main Apr 8, 2026
1 check passed
@nathanjmcdougall nathanjmcdougall deleted the copilot/implement-llm-review-check branch April 8, 2026 00:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Run an LLM review

2 participants